Skip to content

Docs, contributors and citations ahead of release review - #73

Merged
BenjaminWehnert1008 merged 15 commits into
nf-core:devfrom
MaximilianStammnitz:dev
Oct 7, 2026
Merged

BenjaminWehnert1008 merged 15 commits into
nf-core:devfrom
MaximilianStammnitz:dev

Conversation

@MaximilianStammnitz

Copy link
Copy Markdown
Collaborator

Docs, contributors and citations ahead of the release review

Preparation for the first release (#54): documentation, metadata and citations brought up to date with the current pipeline behaviour. No changes to pipeline code or results.

Changes

  • Contributors: Benjamin Wehnert and Maximilian R. Stammnitz as authors/maintainers in the manifest (with ORCIDs and affiliations); Fei Sang, Júlia Mir-Pedrol and Matthias Hörtenhuber as contributors. Manifest description shortened and synced to nextflow_schema.json, .nf-core.yml, the email template and ro-crate-metadata.json
  • README: accurate feature list and pipeline summary; removed claims for not-yet-supported tools; credits and citation section
  • docs/usage.md: samplesheet columns, reference and reading frame, mutagenesis types, and a detailed description of every step matching the current code; parameter details for fitness estimation (--min_counts, --output_pseudocount, see Parameter and samplesheet conventions #69)
  • docs/output.md: rewritten from the test-profile output layout, including deepmutscan_report.html, error-correction outputs, mutscan and the variant effect inspection tool; new example figures
  • nextflow_schema.json: updated parameter descriptions (text only)
  • CHANGELOG.md: v1.0.0 entries and dependency versions
  • CITATIONS.md: added BWA-MEM, VSEARCH, DiMSum, mutscan, edgeR, limma, R packages and others; consistent formatting
  • Methods description: cites the pipeline preprint and nf-core
  • Removed: docs/pipeline_steps.md (merged into usage.md) and a stray log.txt

Related to #54, #69.

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! (not applicable: documentation only)
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>). (CI)
  • 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).

@MaximilianStammnitz

MaximilianStammnitz commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator Author

@BenjaminWehnert1008 please approve review, this is all documentation-related only. Thanks a lot

@MaximilianStammnitz MaximilianStammnitz self-assigned this Oct 5, 2026
@MaximilianStammnitz MaximilianStammnitz added the documentation Improvements or additions to documentation label Oct 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I just implemented an updated seqdepth downsampling in the latest PR, to have smaller step sizes. We can update this screenshot one more time after merge.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

happy to update the screenshot already here, prior to merging

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

done

@BenjaminWehnert1008
BenjaminWehnert1008 merged commit 780cca1 into nf-core:dev Oct 7, 2026
8 checks passed
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

Successfully merging this pull request may close these issues.

2 participants