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

Pipeline output documentation #12

Closed
drpatelh opened this issue Mar 31, 2020 · 3 comments
Closed

Pipeline output documentation #12

drpatelh opened this issue Mar 31, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@drpatelh
Copy link
Member

We will need to properly document/explain all of the outputs generated by the pipeline along with some nice plots and figures:
https://github.com/nf-core/atacseq/blob/dev/docs/output.md

@drpatelh drpatelh added the documentation Improvements or additions to documentation label Mar 31, 2020
@drpatelh
Copy link
Member Author

This was initially added here #48

@drpatelh drpatelh reopened this Apr 27, 2020
@ktrns
Copy link

ktrns commented Apr 27, 2020

Hi @drpatelh

I have made little changes here and there and will create a PR soon.

Questions that came up in usage.md:
Would it be possible to add a sentence to --amplicon_bed and --amplicon_fasta to say what it is needed for? Why is a bed file needed if we map the reads any way? Why is a fasta file needed if we assemble anyways? SOLVED - added some more description in the docs

Why are VarScan2 and iVar used for variant calling of reads against the reference genome, and Minimap2, seqwish, vg for variant calling of de-novo assemblies against the reference genome? Are the latter ones better suited for genome vs. genome? And why is specifically vg failing? Does --run_vg run specifically vg, or Minimap2 and seqwish as well? (I obviously don't know these tools yet and don't know about the concept of a variant graph yet)

Why is especially minia failing and hence not in the defaults for --assemblers? - SOLVED - minia added back in as default

Questions that came up in output.md:
Why are you using different trimming tools? fastp for general adapter trimming, iVar trim before variant calling, Cutadapt before de-novo assembly. SOLVED - Elaborated a bit more in each section to make the distinction clearer

Best
Katrin

@drpatelh
Copy link
Member Author

Docs are looking nice now as of #103

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

No branches or pull requests

2 participants