-
Notifications
You must be signed in to change notification settings - Fork 1k
New tutorial about genome annotation, comparative genomics and visualization #6481
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
base: main
Are you sure you want to change the base?
Conversation
...orials/genome-annotation-comparison-visualization/workflows/Galaxy-Workflow-AnnotComptVis.ga
Show resolved
Hide resolved
topics/genome-annotation/tutorials/genome-annotation-comparison-visualization/tutorial.md
Show resolved
Hide resolved
rlibouba
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello, thank you for this tutorial. Great work!
I've done a first read-through and made some suggestions that you can take into account or not.
The tests fail on lint due to the absence of tests for workflows. A .yml file should be added (example: https://github.com/galaxyproject/training-material/blob/main/topics/genome-annotation/tutorials/helixer/workflows/Helixer-tests.yml). You can generate the skeleton of this file locally. You can find explanations right here: https://github.com/galaxyproject/iwc/tree/main/workflows
| - **Enzyme codes (EC numbers)** | ||
| - **Orthology relationships** | ||
|
|
||
| > <details-title>Background: Why orthology improves functional annotation</details-title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > <details-title>Background: Why orthology improves functional annotation</details-title> | |
| > <details-title>Background: Why orthology improves functional annotation?</details-title> |
| - **GO terms** | ||
| - **KEGG pathways** | ||
| - **COG categories** | ||
| - **Enzyme codes (EC numbers)** | ||
| - **Orthology relationships** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps briefly define these terms? Or explain what they are used for?
| {: .hands_on} | ||
|
|
||
|
|
||
| # Statistics of our genome (gfastats) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| # Statistics of our genome (gfastats) | |
| # Statistics of our genome |
| > | ||
| {: .question} | ||
|
|
||
| # Preparing RNASeq data (RNA STAR) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| # Preparing RNASeq data (RNA STAR) | |
| # Preparing RNASeq data |
| > | ||
| {: .question} | ||
|
|
||
| # Functional annotation (EggNOG Mapper, InterProScan and Funannotate functional) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| # Functional annotation (EggNOG Mapper, InterProScan and Funannotate functional) | |
| # Functional annotation |
|
|
||
| Funannotate functional integrates: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think one or two sentences are missing to introduce funannotate functional.
| > | ||
| {: .question} | ||
|
|
||
| # Visualisation with a genome browser (JBrowse2) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| # Visualisation with a genome browser (JBrowse2) | |
| # Visualisation with a genome browser |
|
|
||
| This visual inspection is crucial to validating genome annotation results. | ||
|
|
||
| > <details-title>Background: Why visualization is important</details-title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > <details-title>Background: Why visualization is important</details-title> | |
| > <details-title>Background: Why visualization is important?</details-title> |
| --- | ||
|
|
||
|
|
||
| # Introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the lint errors, this line must be deleted.
| @@ -0,0 +1,981 @@ | |||
| { | |||
| "a_galaxy_workflow": "true", | |||
| "annotation": "In this tutorial, you will perform a complete workflow for fungal genome annotation, comparative genomics, and visualization. Starting from raw Mucor mucedo genomic and RNA-seq data, you will run Funannotate to generate structural and functional annotations. The predicted proteome is then compared with complete proteomes from related Mucor species and Saccharomyces cerevisiae using OrthoFinder to identify orthogroups and assess evolutionary relationships. Finally, the annotated genome and comparative results are explored and visualized using JBrowse2 for interactive genome browsing and Circos to display synteny and genomic relationships.", | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you summarize it in one or two lines?
shiltemann
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @soniacasillas! Just a few very minor comments below. You can simply hit the "Commit Suggestion" button if you agree, to make the change.
| --- | ||
|
|
||
|
|
||
| # Introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| # Introduction |
We prefer not to start a tutorial with a heading, it makes previews on e.g. chat and social media nicer.
| title: Genome annotation (Funannotate), comparison (OrthoFinder) and visualization | ||
| (JBrowse2 & Circos) [Galaxy Training Material] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| title: Genome annotation (Funannotate), comparison (OrthoFinder) and visualization | |
| (JBrowse2 & Circos) [Galaxy Training Material] | |
| title: Genome annotation, comparison and visualization |
I would simplify the title a bit.
(If you really want to keep the tool names you can, but at least remove the "[Galaxy Training Material]" part)
| layout: tutorial_hands_on | ||
| title: Genome annotation (Funannotate), comparison (OrthoFinder) and visualization | ||
| (JBrowse2 & Circos) [Galaxy Training Material] | ||
| zenodo_link: https://zenodo.org/records/17612216 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get a page not found here, could you double-check if this link is correct and public?
| (JBrowse2 & Circos) [Galaxy Training Material] | ||
| zenodo_link: https://zenodo.org/records/17612216 | ||
| tags: | ||
| - genome annotation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since it is already in the genome annotation topic, we don't need it as a tag
| - genome annotation |
| > 2. Upload the datasets from **<{{ page.zenodo_link }}>** using either: | ||
| > - **Paste/Fetch data** (URLs from Zenodo), or | ||
| > - **Upload from your computer** after downloading the files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is easier for users if we provide the direct URLs to all files in a text box that they can easily copy-paste to Galaxy:
| > 2. Upload the datasets from **<{{ page.zenodo_link }}>** using either: | |
| > - **Paste/Fetch data** (URLs from Zenodo), or | |
| > - **Upload from your computer** after downloading the files. | |
| > 2. Click **Paste/Fetch data** and paste in the following URLs in the box that appears. | |
| > | |
| > ``` | |
| > https://zenodo.org/record/17612216/files/link-to-file-1.txt | |
| > https://zenodo.org/record/17612216/files/file2.fasta | |
| > ```` |
I added a new tutorial about genome annotation, comparative genomics and visualization (under the topic genome-annotation).
It uses this workflow on UseGalaxy.eu:
https://usegalaxy.eu/u/scasillas/w/genome-annotation-funannotate-comparison-orthofinder-and-visualization-jbrowse2--circos-galaxy-training-material
It is my first contributed tutorial. Please let me know if anything needs to be corrected.
Thank you!