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

Add new tutorial for deciphering viral populations using SNV and baculovirus isolates (Variant analysis) #5700

Open
wants to merge 47 commits into
base: main
Choose a base branch
from

Conversation

wennj
Copy link

@wennj wennj commented Jan 17, 2025

Dear GTN Team,

I am a new contributor and have created a tutorial for analysing virus populations using SNV (and using the example of large dsDNA viruses). The workflow is based on published results and follows a scientific approach. I have followed the GTN instructions as closely as possible (and as I understand them). Please excuse any mistakes in using Github. The tutorial has also been reviewed by a student.

Key changes:

  • Added a new step-by-step tutorial (variant-analysis/baculovirus-isolate-variation) for analysing viral populations on the example of baculovirus isolates
  • CONTRIBUTORS.yaml was changed.

Checked:

  • Images can be re-hosted.

Help:

  • One image in the introduction is linked to ICTV.global. Allowed?

TODO:

  • Tool bcftools mpileup / bcftools call are using DPR (deprecated but functional). Needs to be changed to AD in the future.
  • Awaiting feedback and suggestions for improvement.
  • Refine the tutorial based on reviewer comments.

Best,
JTW

Copy link
Member

@bgruening bgruening left a comment

Choose a reason for hiding this comment

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

Very cool! Welcome @wennj!

I have added a few batch of comments, if you agree with them you can accept them from inside the github interface.

wennj and others added 17 commits January 18, 2025 14:53
I just did something wrong when trying to solve this comment plus adding an additional change.
@wennj
Copy link
Author

wennj commented Jan 18, 2025

@bgruening Many thanks for the suggestions and feedback. I have addressed all comments. As this is my first tutorial and my first pull request, I hope everything is checked correctly.

@bgruening
Copy link
Member

Thanks a lot! Let's wait for some experts in this area to get some content feedback.

Can you please add the jki to this file as well: https://github.com/galaxyproject/training-material/blob/main/ORGANISATIONS.yaml this will then generate a page like: https://training.galaxyproject.org/hall-of-fame/uni-freiburg/

@wennj
Copy link
Author

wennj commented Jan 20, 2025

Thanks a lot! Let's wait for some experts in this area to get some content feedback.

Can you please add the jki to this file as well: https://github.com/galaxyproject/training-material/blob/main/ORGANISATIONS.yaml this will then generate a page like: https://training.galaxyproject.org/hall-of-fame/uni-freiburg/

I would like to check that first with my administration. Can this also be done at a later stage?

CONTRIBUTORS.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@wm75 wm75 left a comment

Choose a reason for hiding this comment

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

Very nice work @wennj !
Those awk expressions are rather intimidating for beginners I guess, but also elegant compared to multi-step solutions with other tools.
Can be interesting to teach them :-)

@wennj
Copy link
Author

wennj commented Jan 24, 2025

Very nice work @wennj ! Those awk expressions are rather intimidating for beginners I guess, but also elegant compared to multi-step solutions with other tools. Can be interesting to teach them :-)

Thank you for your time, the valuable comments and suggestions @wm75 . It took a while to make all the necessary changes but I think that all the comments have been addressed. The tutorial has improved!

Copy link
Contributor

@wm75 wm75 left a comment

Choose a reason for hiding this comment

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

The remaining CI issues are:

{"message":"This workflow is missing a test, which is now mandatory. Please see [the FAQ on how to add tests to your workflows](https://training.galaxyproject.org/training-material/faqs/gtn/gtn_workflow_testing.html).","location":{"path":"./topics/variant-analysis/tutorials/baculovirus-isolate-variation/workflows/main_workflow.ga","range":{"start":{"line":1,"column":1},"end":{"line":1,"column":1}}},"severity":"ERROR","code":{"value":"GTN:027","url":"https://training.galaxyproject.org/training-material/gtn_rdoc/Gtn/Linter.html#method-c-"}}
{"message":"This looks like a DOI which could be better served by using the built-in Citations mechanism. You can use https://doi2bib.org/ to convert your DOI into a .bib formatted entry, and add to your tutorial.md","location":{"path":"./topics/variant-analysis/tutorials/baculovirus-isolate-variation/tutorial.md","range":{"start":{"line":202,"column":97},"end":{"line":202,"column":159}}},"severity":"WARNING","code":{"value":"GTN:004","url":"https://training.galaxyproject.org/training-material/gtn_rdoc/Gtn/Linter.html#method-c-check_dois"},"suggestions":[{"text":"{% cite ... %}","range":{"start":{"line":202,"column":97},"end":{"line":202,"column":159}}}]}
{"message":"Please do not include an # Introduction section, it is unnecessary here, just start directly into your text. The first paragraph that is seen by our infrastructure will automatically be shown in a few places as an abstract.","location":{"path":"./topics/variant-analysis/tutorials/baculovirus-isolate-variation/tutorial.md","range":{"start":{"line":1,"column":1},"end":{"line":2,"column":1}}},"severity":"ERROR","code":{"value":"GTN:046","url":"https://training.galaxyproject.org/training-material/gtn_rdoc/Gtn/Linter.html#method-c-useless_intro"},"suggestions":[{"text":"","range":{"start":{"line":1,"column":1},"end":{"line":2,"column":1}}}]}

Let me know if you have trouble with the workflow tests ...

... and please remember to pull my changes first before continuing to work on your local version.

@wennj
Copy link
Author

wennj commented Jan 30, 2025

@wm75 I think I pulled your changes this time. And I'm starting to understand how the automated tests work. I have added the workflow test files, as well. Let me know if any changes are required. Sorry for the trouble with the Gemfile.lock.

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.

3 participants