-
Notifications
You must be signed in to change notification settings - Fork 223
Strip params docs #700
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
Strip params docs #700
Conversation
This comment has been minimized.
This comment has been minimized.
|
(Rebased with upstream changes) |
People can read about these on nf-core/configs I think, as that's where the config profile is kept.
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/docs/usage.md
Outdated
Show resolved
Hide resolved
|
|
||
| ## Reference genomes | ||
|
|
||
| The pipeline config files come bundled with paths to the illumina iGenomes reference index files. If running with docker or AWS, the configuration is set up to use the [AWS-iGenomes](https://ewels.github.io/AWS-iGenomes/) resource. |
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 the pipeline schema template doesn't explain what iGenomes is. I liked this and the longer explanation in line 78+, otherwise it seems rather cryptic to newcomers.
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 added a link to the website docs in the schema in cb72dda - is this ok?
We're probably dropping all if iGenomes soon anyway, so I'm not too fussed.
ggabernet
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.
Looks good to me!
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/nextflow_schema.json
Outdated
Show resolved
Hide resolved
…ow_schema.json Co-authored-by: Gisela Gabernet <[email protected]>
Start stripping out parameter docs from template
usage.md. See #647