Skip to content

added wkflw run snippets to VGP wkflw tutorial#5132

Merged
hexylena merged 15 commits intogalaxyproject:mainfrom
abueg:vgp_wkflws_launchsnippets
Jul 26, 2024
Merged

added wkflw run snippets to VGP wkflw tutorial#5132
hexylena merged 15 commits intogalaxyproject:mainfrom
abueg:vgp_wkflws_launchsnippets

Conversation

@abueg
Copy link
Copy Markdown
Contributor

@abueg abueg commented Jul 5, 2024

hello! 👋🏼 this edit adds the dockstore workflow launch snippets to the VGP workflow-focused tutorial, and accordingly removes text about importing workflows from github

@abueg abueg requested a review from a team as a code owner July 5, 2024 18:41
@abueg
Copy link
Copy Markdown
Contributor Author

abueg commented Jul 5, 2024

THE LISTS I WAS SUPPOSED TO FIX ok i can fix that this weekend!

edit: i changed the problematic lists to just headers, which i think makes more sense since they're kind of dividing subsections anyway 🤔

@abueg abueg marked this pull request as draft July 5, 2024 19:19
@abueg abueg marked this pull request as ready for review July 5, 2024 23:32
@hexylena hexylena self-assigned this Jul 6, 2024
![Workflow menu](../../images/vgp_assembly/imported_workflows.png "Workflow list. The workflow menu lists all the workflows that have been imported. It provides useful information for organizing the workflows, such as last update and the tags. The workflows can be run by clicking in the play icon, marked in red in the image.")

Once we have imported the datasets and the workflows, we can start with the genome assembly.
All analyses described in this tutorial are performed using *workflows*--chains of tools--shown in [Fig. 1](#figure-1). Specifically, we will use four workflows corresponding to analysis trajectory **B**: 1, 4, 6, and 8. To use these four workflows you need to import them into your Galaxy account following the steps below. Note: these are not necessarily the latest versions of the actual workflows, but versions that have been tested for this tutorial. To see the latest versions, see the [Galaxy Project VGP workflows page](https://galaxyproject.org/projects/vgp/workflows/) and click on the Dockstore links to import workflows. **Alternatively, for each section of the tutorial, there will be a "Launch [workflow] (View on Dockstore)" link at the beginning, which you can use to launch the workflow.**
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are not necessarily the latest versions of the actual workflows

But they are the latest versions: you've linked to IDs like github.com/iwc-workflows/kmer-profiling-hifi-VGP1/main which seem to point to the latest version of each workflow. Did you mean to pin these to specific versions instead?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK thank you for catching that!! 🙏🏼 I'll edit the snippets to pin to specific versions, because that would make more sense to prevent people from using latest versions that might not match up with what's presented in this tutorial

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, I'm sorry, do you happen to know if there is a way to pin the TRS ID to a specific version? clicking to a different version on the Dockstore page changes just the Source code but not the TRS...

I tried changing it to github.com/iwc-workflows/kmer-profiling-hifi-VGP1/versions/v0.1.5 and github.com/iwc-workflows/kmer-profiling-hifi-VGP1/v0.1.5 but those lead to a 404 error :(

Copy link
Copy Markdown
Member

@hexylena hexylena Jul 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh. When i select an old version on dockstores own launch page, and try and launch it in EU it generated an unversioned url:

https://usegalaxy.eu/workflows/trs_import?trs_server=dockstore.org&trs_id=%23workflow/github.com/iwc-workflows/kmer-profiling-hifi-VGP1/main

that's completely broken useless lol, you select the version once in dockstore and are again presented with a version selector in galaxy? wild.

i'll poke their API in a bit to see what format is required (if it is possible) to generate more specific urls

looks like it was a known issue a while back. so dockstores website is still broken but at least it is possible: galaxyproject/galaxy#12017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I've added a version parameter (e.g. version="v0.1.5") to the snippet. Could you please add the versions to each snippet usage? :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

success! adding that parameter makes the URL fill like this: https://usegalaxy.org/workflows/trs_import?trs_server=dockstore.org&run_form=true&trs_id=%23workflow/github.com/iwc-workflows/kmer-profiling-hifi-VGP1/main&trs_version=v0.1.5 and the page that loads automatically loads the wkflw -> wkflw run page. i'll update the snippets to use the version parameter, thank you so much for your help!!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for the sake of documentation, here's what happens when the snippet specifies a version # that doesn't exist: the user's taken to this page with the "version xyz doesn't exist" message and then they can pick the version 👍🏼
image

the tutorial's snippets should now all have a version pinned 📌 🚀

@hexylena hexylena force-pushed the vgp_wkflws_launchsnippets branch from 00c69e1 to 4abf9fc Compare July 8, 2024 08:47
@hexylena hexylena merged commit fd339f7 into galaxyproject:main Jul 26, 2024
@abueg
Copy link
Copy Markdown
Contributor Author

abueg commented Jul 26, 2024

yay!! thank you 🚀

@abueg abueg deleted the vgp_wkflws_launchsnippets branch August 9, 2024 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants