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

Document valid options for "--genome" parameter #889

Closed
hendrikweisser opened this issue Oct 24, 2022 · 2 comments
Closed

Document valid options for "--genome" parameter #889

hendrikweisser opened this issue Oct 24, 2022 · 2 comments
Assignees
Milestone

Comments

@hendrikweisser
Copy link

Description of feature

I find the documentation for the use of reference genomes from iGenomes lacking (see https://nf-co.re/rnaseq/3.9/parameters#reference-genome-options). Apart from "GRCh38", which is mentioned in the extended help text, what other "IDs" are valid for this parameter? And which specific reference genome sources do they map to?

I've looked through a lot of documentation and followed a lot of links (e.g. https://nf-co.re/usage/reference_genomes, https://ewels.github.io/AWS-iGenomes/, https://support.illumina.com/sequencing/sequencing_software/igenome.html), but couldn't find a clear answer.

It may also be helpful to mention where the reference files get downloaded to (I think work/stage/*/* in the output directory), in case they're needed for further analysis.

@hendrikweisser
Copy link
Author

It looks like this source file has the relevant information:
https://github.com/nf-core/rnaseq/blob/master/conf/igenomes.config

@drpatelh drpatelh added this to the 3.10 milestone Dec 12, 2022
@drpatelh drpatelh self-assigned this Dec 20, 2022
drpatelh added a commit to drpatelh/nf-core-rnaseq that referenced this issue Dec 20, 2022
@drpatelh
Copy link
Member

Thanks for reporting!

Docs added in pipeline here: nf-core/website#1501

I re-wrote the main docs on the website to make this clearer in #913. See link below:
https://nf-co.re/usage/reference_genomes#illumina-aws-igenomes

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

No branches or pull requests

2 participants