Skip to content

Commit

Permalink
Merge branch 'main' into sujaikumar-lotus2-identifying-fungi
Browse files Browse the repository at this point in the history
  • Loading branch information
paulzierep authored Sep 30, 2024
2 parents da14f50 + d82c580 commit effcc9e
Show file tree
Hide file tree
Showing 9 changed files with 181 additions and 4 deletions.
2 changes: 1 addition & 1 deletion events/galaxy-academy-2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cover-image-alt: logo for the Galaxy Academy event consisting of a laptop surrou

registration:
link: https://forms.gle/cxzVatt7MAgiMX12A
deadline: 2024-09-30
deadline: 2024-10-04
open: true

date_start: 2024-10-07
Expand Down
15 changes: 14 additions & 1 deletion faqs/gtn/gtn_workflow_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ box_type: tip
contributors: [hexylena]
---

## Ensuring a Tutorial has a Workflow

1. Find a tutorial that you're interested in, that **doesn't currently have tests.**

This tutorial has a workflow (`.ga`) and a test, notice the `-test.yml` that has the same name as the workflow `.ga` file.
Expand All @@ -21,6 +23,15 @@ contributors: [hexylena]
3. Follow the tutorial
4. Extract a workflow from the history
5. Run that workflow in a new history to test

## Extract Tests (Online Version)

If you are on UseGalaxy.org or another server running 24.2 or later, you can use [PWDK](https://pwdk.apps.galaxyproject.eu/), a version of planemo running online to generate the workflow tests.

However if you are on an older version of Galaxy, or a private Galaxy server, then you'll need to do the following:

## Extract Tests (Manual Version)

6. Obtain the workflow invocation ID, and your API key (User → Preferences → Manage API Key)

![screenshot of the workflow invocation page. The user drop down shows where to find this page, and a red box circles a field named "Invocation ID"]({% link faqs/gtn/images/invocation.png %})
Expand Down Expand Up @@ -50,6 +61,8 @@ contributors: [hexylena]
└── testing-openlayer-tests.yml
```

## Adding Your Tests to the GTN

9. You will need to check the `-tests.yml` file, it has some automatically generated comparisons. Namely it tests that output data matches the test-data exactly, however, you might want to replace that with assertions that check for e.g. correct file size, or specific text content you expect to see.

10. If the files in test-data are already uploaded to Zenodo, to save disk space, you should delete them from the `test-data` dir and use their URL in the `-tests.yml` file, as in this example:
Expand Down Expand Up @@ -88,4 +101,4 @@ contributors: [hexylena]
n: 2
```
12. Contribute all of those files to the GTN in a PR.
12. Contribute all of those files to the GTN in a PR, adding them to the `workflows/` folder of your tutorial.
Original file line number Diff line number Diff line change
@@ -1,3 +1,154 @@
GTN_GTN:1727436959

topics/genome-annotation/tutorials/amr-gene-detection/tutorial.md
GTN_GTN:1727434118

Gemfile.lock
GTN_GTN:1727434087

topics/assembly/tutorials/vgp_genome_assembly/tutorial.md
topics/community/tutorials/sig_define/tutorial.md
topics/dev/tutorials/community-tool-table/tutorial.md
topics/dev/tutorials/tool-annotation/tutorial.md
topics/dev/tutorials/tool-from-scratch/tutorial.md
topics/dev/tutorials/tool-generators-advanced/tutorial.md
topics/fair/tutorials/fair-data-registration/tutorial.md
topics/fair/tutorials/ro-crate-galaxy-best-practices/tutorial.md
topics/genome-annotation/tutorials/secondary-metabolite-discovery/tutorial.md
topics/microbiome/tutorials/pathogen-detection-from-nanopore-foodborne-data/tutorial.md
topics/single-cell/tutorials/GO-enrichment/tutorial.md
topics/single-cell/tutorials/scrna-case_alevin-combine-datasets/tutorial.md
topics/transcriptomics/tutorials/differential-isoform-expression/tutorial.md
topics/variant-analysis/tutorials/beacon_cnv_query/tutorial.md
topics/variant-analysis/tutorials/beaconise_1000hg/tutorial.md
GTN_GTN:1727366404

topics/variant-analysis/tutorials/sars-cov-2-variant-discovery/tutorial.md
GTN_GTN:1727344222

_layouts/event.html
GTN_GTN:1727343522

.github/workflows/ci-main.yml
GTN_GTN:1727343258

_config.yml
assets/js/main.js
assets/js/tutorial-mode.js
GTN_GTN:1727342401

topics/data-science/tutorials/sql-advanced/tutorial.md
GTN_GTN:1727339855

_plugins/jekyll-jsonld.rb
GTN_GTN:1727337973

_config.yml
assets/js/main.js
assets/js/tutorial-mode.js
GTN_GTN:1727337768

_config.yml
faqs/galaxy/workflows_best_practices.md
topics/fair/tutorials/ro-crate-galaxy-best-practices/img/workflow-entry.png
topics/fair/tutorials/ro-crate-galaxy-best-practices/img/workflow-invocation.png
topics/fair/tutorials/ro-crate-galaxy-best-practices/img/workflow-run-page.png
topics/fair/tutorials/ro-crate-galaxy-best-practices/tutorial.md
topics/fair/tutorials/ro-crate-submitting-life-monitor/tutorial.md
GTN_GTN:1727337201

topics/assembly/tutorials/assembly-decontamination/tutorial.md
GTN_GTN:1727336779

topics/microbiome/tutorials/dada-16S/tutorial.md
GTN_GTN:1727335798

topics/assembly/tutorials/mitochondrion-assembly/tutorial.md
GTN_GTN:1727277279

_plugins/jekyll-jsonld.rb
_plugins/util.rb
GTN_GTN:1727255537

_layouts/event-track.html
events/galaxy-academy-2024.md
events/tracks/gta2024-assembly.md
events/tracks/gta2024-bacterial-genomics.md
events/tracks/gta2024-bycovid.md
events/tracks/gta2024-microbiome.md
events/tracks/gta2024-ml.md
events/tracks/gta2024-proteomics.md
events/tracks/gta2024-single-cell.md
events/tracks/gta2024-transcriptomics.md
GTN_GTN:1727255502

bin/lint.rb
GTN_GTN:1727253183

bin/news.rb
GTN_GTN:1727250881

topics/admin/tutorials/interactive-tools/slides.html
topics/admin/tutorials/interactive-tools/tutorial.md
GTN_GTN:1727189728

topics/microbiome/tutorials/diversity/tutorial.md
GTN_GTN:1727129913

topics/single-cell/tutorials/scrna-scanpy-pbmc3k/tutorial.md
GTN_GTN:1727102130

metadata/workflowhub.yml
GTN_GTN:1727090456

_includes/instance-dropdown.html
_layouts/topic.html
GTN_GTN:1727076651

topics/ecology/tutorials/Ecoregionalization_tutorial/Images/2_example.png
topics/ecology/tutorials/Ecoregionalization_tutorial/Images/BRT-Echinodermata_Crinoidea_Comatulida_Antedonidae_Florometra_mawsoni__pred_plot.png
topics/ecology/tutorials/Ecoregionalization_tutorial/Images/JLN_param_example.png
topics/ecology/tutorials/Ecoregionalization_tutorial/Images/Map.png
topics/ecology/tutorials/Ecoregionalization_tutorial/Images/NA_example.png
topics/ecology/tutorials/Ecoregionalization_tutorial/Images/advanced_out_example.png
topics/ecology/tutorials/Ecoregionalization_tutorial/Images/pivot_file_example.png
topics/single-cell/images/GO-enrichment/slides_images/components_5.png
topics/single-cell/images/GO-enrichment/slides_images/enrichment_7.png
topics/single-cell/images/GO-enrichment/slides_images/example1_16.png
topics/single-cell/images/GO-enrichment/slides_images/example2.png
topics/single-cell/images/GO-enrichment/slides_images/example2_int.png
topics/single-cell/images/GO-enrichment/slides_images/example_6.png
topics/single-cell/images/GO-enrichment/slides_images/go_3.png
topics/single-cell/images/GO-enrichment/slides_images/go_enrichment_8.png
topics/single-cell/images/GO-enrichment/slides_images/hierarchy_4.png
topics/single-cell/images/GO-enrichment/slides_images/interpretation_18.png
topics/single-cell/images/GO-enrichment/slides_images/m_17.png
topics/single-cell/images/GO-enrichment/slides_images/ontology_2.png
topics/single-cell/images/GO-enrichment/slides_images/purpose_19.png
topics/single-cell/images/GO-enrichment/slides_images/roadmap_1.png
topics/single-cell/images/GO-enrichment/slides_images/step1_9.png
topics/single-cell/images/GO-enrichment/slides_images/step2_10.png
topics/single-cell/images/GO-enrichment/slides_images/step3_11.png
topics/single-cell/images/GO-enrichment/slides_images/step4_12.png
topics/single-cell/images/GO-enrichment/slides_images/step5_13.png
topics/single-cell/images/GO-enrichment/slides_images/step6_14.png
topics/single-cell/images/GO-enrichment/slides_images/step7_15.png
topics/single-cell/images/scrna-scanpy-pbmc3k/dotplot_annotated_clusters.png
topics/single-cell/images/scrna-scanpy-pbmc3k/qc_violin_plot.png
topics/single-cell/images/scrna-scanpy-pbmc3k/umap_after_clustering.png
topics/single-cell/images/scrna-scanpy-pbmc3k/umap_annotated_clusters.png
topics/single-cell/images/scrna-scanpy-pbmc3k/umap_before_clustering.png
topics/single-cell/images/scrna-scanpy-pbmc3k/umap_plot_marker_genes.png
topics/single-cell/images/scrna-scanpy-pbmc3k/violin_plot_marker_genes.png
topics/single-cell/images/scrna-scanpy-pbmc3k/violin_plot_rank_genes_groups_CST3_NKG7_PPBP.png
topics/single-cell/images/workflow.png
GTN_GTN:1727076602

metadata/git-mod-efc7be5ba874506b92c304fa69236167ebd2e82a.txt
metadata/git-pub-efc7be5ba874506b92c304fa69236167ebd2e82a.txt
GTN_GTN:1727076570

metadata/shortlinks.yaml
GTN_GTN:1727009190

topics/introduction/tutorials/galaxy-intro-101/tutorial.md
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
GTN_GTN:1727337973

A assets/js/tutorial-mode.js
GTN_GTN:1727076602

R099 metadata/git-mod-b5acaf862a6ef65d9660d4ea2d6152029e21f078.txt metadata/git-mod-efc7be5ba874506b92c304fa69236167ebd2e82a.txt
R099 metadata/git-pub-b5acaf862a6ef65d9660d4ea2d6152029e21f078.txt metadata/git-pub-efc7be5ba874506b92c304fa69236167ebd2e82a.txt
GTN_GTN:1726674476

A topics/single-cell/faqs/gtn-in-galaxy_mode-cs.md
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Providing documentation is also important to help understand the workflow's purp

> <agenda-title></agenda-title>
>
> In this tutorial, you will learn about the best practices that the Galaxy community has created for workflows.
> In this tutorial, you will learn about the best practices that the Galaxy community
> has created for workflows.
>
> 1. TOC
> {:toc}
Expand Down Expand Up @@ -122,6 +123,11 @@ As an example we will use this [simple workflow](https://github.com/crs4/life_mo
>
> 1. Run `planemo workflow_test_init --galaxy_url https://usegalaxy.eu --from_invocation INVOCATION_ID --galaxy_user_key API_KEY`, replacing `INVOCATION_ID` with the actual invocation ID and `API_KEY` with the actual API key. If you're not using the Galaxy Europe instance, also replace `https://usegalaxy.eu` with the URL of the instance you're using.
> 1. Browse the files that have been created - `sort-and-change-case-tests.yml` and `test_data/`
>
> Optionally see this tip for more details:
>
> {% snippet faqs/gtn/gtn_workflow_testing.md %}
>
{: .hands_on}

> <question-title></question-title>
Expand Down
2 changes: 1 addition & 1 deletion topics/proteomics/tutorials/encyclopedia/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ In a typical DIA-MS experiment, the precursor scan usually ranges between 400-10
> https://zenodo.org/records/13505774/files/191023JAT06_P_1ug_595_705_4_20.raw
> https://zenodo.org/records/13505774/files/191023JAT07_P_1ug_695_805_4_20.raw
> https://zenodo.org/records/13505774/files/191023JAT08_P_1ug_795_905_4_20.raw
> ttps://zenodo.org/records/13505774/files/191023JAT09_P_1ug_895_1005_4_20.raw
> https://zenodo.org/records/13505774/files/191023JAT09_P_1ug_895_1005_4_20.raw
> https://zenodo.org/record/4926594/files/T4_Salmonella_Ecoli_Bacillus_BS_191102.fasta
> https://zenodo.org/record/4926594/files/T4_Salmonella_Ecoli_Bacillus_fasta_trypsin_z2_nce33_BS_191102.dlib
> ```
Expand Down

0 comments on commit effcc9e

Please sign in to comment.