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.

Sign up for GitHub

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

Jump to bottom

Update documentation: ASV post processing & parameters description #762

Merged
merged 2 commits into from
Jul 15, 2024
Merged

Update documentation: ASV post processing & parameters description #762

merged 2 commits into from
Jul 15, 2024

Conversation

d4straub
Copy link
Collaborator

@d4straub d4straub commented Jul 15, 2024 •
edited
Loading

ASV post processing includes ASV clustering and filtering and had changes. This part is updated now in the output documentation.
Additionally, descriptions of sections in the parameters documentation were added.

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 you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/ampliseq branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 15, 2024 •
edited
Loading

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 6558d3e

+| ✅ 285 tests passed       |+
#| ❔   6 tests were ignored |#
!| ❗   1 tests had warnings |!

❗ Test warnings:

  • readme - README did not have a Nextflow minimum version badge.

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-07-15 12:13:59

tillenglert
tillenglert approved these changes Jul 15, 2024
View reviewed changes
Copy link
Contributor

@tillenglert tillenglert left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@d4straub
Copy link
Collaborator Author

Thanks!

@d4straub d4straub merged commit 11135f6 into nf-core:dev Jul 15, 2024
17 checks passed
@d4straub d4straub deleted the output-docs-asv-post-processing branch July 15, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tillenglert tillenglert tillenglert approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@d4straub @tillenglert