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

Typo in output documentation and output documentation reporting in pipeline summary #895

Closed
RodrigoBarquera opened this issue Jun 13, 2022 · 1 comment · Fixed by #896
Closed
Labels
bug Something isn't working

Comments

@RodrigoBarquera
Copy link

nf-core/Eager Team:

I found a typo in the documentation for Eager. In https://nf-co.re/eager/2.4.4/output#output-files section mapping/, it says:

"You will also find a corresponding BAM index file (ending in .csi or .bam)"

and it should say:

"You will also find a corresponding BAM index file (ending in .bai)"

Also, I have a suggestion for the documentation at the end of the MultiQC report/pipeline summary: you could add the paths to the main output files (.fq, .bam) there for a quick reference, especially for new users/changes in regular sequencing outputs.

Thanks.

@RodrigoBarquera RodrigoBarquera added the bug Something isn't working label Jun 13, 2022
@jfy133 jfy133 mentioned this issue Jun 13, 2022
11 tasks
@jfy133
Copy link
Member

jfy133 commented Jun 13, 2022

I won't add the paths to the main output files, as we have no idea what the user will cosnider the main output files (we have main possible).

However I have added a link to the output docs in the pipeline summary where this is all describe already

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants