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

First draft output docs #48

Merged
merged 29 commits into from
Apr 14, 2020
Merged

First draft output docs #48

merged 29 commits into from
Apr 14, 2020

Conversation

saramonzon
Copy link
Contributor

@saramonzon saramonzon commented Apr 13, 2020

nf-core/viralrecon pull request

Many thanks for contributing to nf-core/viralrecon!

Please fill in the appropriate checklist below (delete whatever is not relevant).
These are the most common things requested on pull requests (PRs).

PR checklist

  • This comment contains a description of changes (with reason)
  • If you've fixed a bug or added code that should be tested, add tests!
  • If necessary, also make a PR on the nf-core/viralrecon branch on the nf-core/test-datasets repo
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • Make sure your code lints (nf-core lint .).
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

Learn more about contributing: CONTRIBUTING.md

@drpatelh drpatelh added the WIP Work in progress label Apr 13, 2020
docs/output.md Outdated
[Fastp](https://github.com/OpenGene/fastp) is a tool designed to provide fast all-in-one preprocessing for FastQ files. This tool is developed in C++ with multithreading supported to afford high performance.

**Output directory: `preprocess/fastp`**
* `sample.trim.fastq.gz`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `sample.trim.fastq.gz`
* `<SAMPLE>.trim.fastq.gz`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use that notation throughout?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay I'll replace the rest of the samples and finish polishing it a little bit more.

docs/output.md Outdated
@@ -27,6 +47,247 @@ For further reading and documentation see the [FastQC help](http://www.bioinform
* `zips/sample_fastqc.zip`
* zip file containing the FastQC report, tab-delimited data file and plot images

### Quality filtering and adaptor rrimming
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Quality filtering and adaptor rrimming
### Quality filtering and adapter trimming

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of quick things I spotted :) I'll have a proper look when you have finished.

@drpatelh drpatelh merged commit d966acc into nf-core:dev Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP Work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants