Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Long vgp tutorial edits #4542

Merged
merged 29 commits into from
Jan 12, 2024
Merged

Conversation

nekrut
Copy link
Collaborator

@nekrut nekrut commented Nov 21, 2023

No description provided.

@shiltemann
Copy link
Member

@nekrut let me know when this is ready for review :)

@bgruening bgruening marked this pull request as ready for review November 27, 2023 13:02
@bgruening
Copy link
Member

I think he forgot over the holidays.

@nekrut
Copy link
Collaborator Author

nekrut commented Nov 27, 2023

I think he forgot over the holidays.

No - no, just busy with something else. Will resume soon...

Copy link
Member

@shiltemann shiltemann left a comment

Choose a reason for hiding this comment

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

@nekrut I made some minor tweaks on the technical/framework side, and added some border for figures (currently only for figures with captions)

image

@@ -1,3635 +0,0 @@
{
Copy link
Member

Choose a reason for hiding this comment

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

would be great to keep a copy of the workflow in the GTN (also for testing purposes)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes. But let them stabilize a little.They are tested via IWC mechanics. It is in fact quire difficult to test assembly workflows because underlying test data is usually large. Let's keep them outside for now.

Copy link
Member

Choose a reason for hiding this comment

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

We just need a workflow here that reflects the steps that are in the tutorial, as a resource for learners and instructors. If the tutorial corresponds exactly to the IWC workflow, just add a copy here. If not, please generate a workflow that matches the tutorial. If tests are problematic we will accept it without.

I can help if needed.

Copy link
Member

Choose a reason for hiding this comment

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

Can you guarantee that users will get the workflow via TRS and not through the potentially out of date and not automatically updatable workflow in the GTN ?

Copy link
Member

Choose a reason for hiding this comment

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

The GTN workflow only needs to be up-to-date with the hands-on steps as written in the tutorial, not the latest version of the VGP workflow in general. In the tutorial text you can still point to the WFH/IWC as the main source for the latest version.

(Maybe I misunderstood what you mean?)

Copy link
Member

Choose a reason for hiding this comment

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

fwiw, in this version of the tutorial learners are not instructed to use a WF at all, only perform all the steps manually.

@nekrut
Copy link
Collaborator Author

nekrut commented Jan 11, 2024

@nekrut let me know when this is ready for review :)

Ready

Comment on lines 357 to 361
<div id="genomescope">
<!-- Anchor for linking -->
</div>

## Genome profiling with **GenomeScope2**
Copy link
Member

Choose a reason for hiding this comment

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

you don't need this div, you can just link to #genome-profiling-with-genomescope2 (found via clicking on the link from the agenda on the published page)

https://training.galaxyproject.org/training-material/topics/assembly/tutorials/vgp_genome_assembly/tutorial.html#genome-profiling-with-genomescope2

We have obtained the fully phased contig graphs (as {GFA} files) of hap1 and hap2, but these must be converted to FASTA format for subsequent steps. We will use a tool developed from the VGP: **gfastats**. gfastats is a tool suite that allows for manipulation and evaluation of FASTA and GFA files, but in this instance we will use it to convert our GFAs to FASTA files. Later on we will use it to generate standard summary statistics for our assemblies.
We have obtained the fully phased contig graphs (as {GFA} files) of hap1 and hap2, but these must be converted to FASTA format for subsequent steps. We will use a tool developed from the VGP: [`gfastats`](https://github.com/vgl-hub/gfastats). `gfastats` is a tool suite that allows for manipulation and evaluation of FASTA and GFA files, but in this instance we will use it to convert our GFAs to FASTA files. Later on we will use it to generate standard summary statistics for our assemblies.

<div id="hap1_contigs">
Copy link
Member

Choose a reason for hiding this comment

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

all hands on boxes can be linked to, see them on the page, they have a "link to here" button. https://training.galaxyproject.org/training-material/topics/assembly/tutorials/vgp_genome_assembly/tutorial.html#hands-on-convert-gfa-to-fasta

Copy link
Collaborator Author

@nekrut nekrut Jan 11, 2024

Choose a reason for hiding this comment

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

One problem with anchors is that if the tutorial uses branching (cyoa) and the anchor within a branch that is not selected at the moment - it does not work. Also, there may be hands-on boxes with identical names and these seem to be resolved with numbers that keep incrementing. Anyway - I did remove these.

@bgruening bgruening changed the title Long vgp tutorial edits (WIP) Long vgp tutorial edits Jan 12, 2024
@bgruening bgruening merged commit ed8de61 into galaxyproject:main Jan 12, 2024
3 checks passed
@bgruening
Copy link
Member

Paper is on its way! Thanks, everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants