Skip to content

Tidy-up batch: docs, schema, configs, single trivial correctness fix#1849

Merged
pinin4fjords merged 6 commits into
devfrom
tidy-up-1845
May 8, 2026
Merged

Tidy-up batch: docs, schema, configs, single trivial correctness fix#1849
pinin4fjords merged 6 commits into
devfrom
tidy-up-1845

Conversation

@pinin4fjords
Copy link
Copy Markdown
Member

@pinin4fjords pinin4fjords commented May 8, 2026

Summary

Bundles tidy-ups from #1845 — no behaviour, runtime, or output changes.

  • README QC list: mark Preseq as optional (it is skip_preseq = true by default) and add a bullet pointing at RustQC as an experimental single-pass alternative to RSeQC/Qualimap/dupRadar/Preseq/SAMtools-stats (matches the existing schema framing).
  • nextflow_schema.json: drop TODO: ... text that was leaking into the rendered help for kallisto_quant_fraglen and kallisto_quant_fraglen_sd; clarify the values are in base pairs.
  • nextflow_schema.json: explicitly declare "default": false for skip_dupradar, skip_qualimap, skip_rseqc, skip_biotype_qc, skip_deseq2_qc (matching nextflow.config), and note that the four QC-tool flags have no effect under --use_rustqc (experimental).
  • workflows/rnaseq/main.nf: change three guard conditions from bitwise & to logical && for consistency with the rest of the file (no behaviour change since operands are always truthy/falsy).
  • conf/modules/featurecounts.config: delete the duplicate withName: 'CUSTOM_MULTIQCCUSTOMBIOTYPE' block (the same block in conf/modules/multiqc_custom_biotype.config is the authoritative one and wins by inclusion order).
  • conf/modules/align_star.config: merge two adjacent withName blocks that target the same selector (one set ext.args, the other publishDir) into a single block.
  • Remove bin/fastq_dir_to_samplesheet.py: not referenced from any .nf, last functional change in 2023; CHANGELOG already directs users to nf-core/fetchngs for samplesheet generation.
  • modules/local/deseq2_qc/main.nf: kept the stub's input-driven for i in \head $counts -n 1 | cut -f3-`loop and added a short comment explaining why — the module test snapshotsprocess.out.size_factors` and asserts one per-sample file per data column of the input counts, so the stub must mirror live-run output. (Tidy-up batch: docs, schema, configs, single trivial correctness fix #1845 sub-item 5 was originally to replace the loop with fixed touches, but per the issue's own guidance "if any one of them turns out to be more involved than expected, drop it from this PR" the deeper change is left for a follow-up.)

ro-crate-metadata.json is updated by nf-core pipelines lint --fix to keep the embedded README description in sync.

Closes #1845.

Test plan

  • nf-core pipelines lint passes (0 failed, 600 passed; only pre-existing warnings remain)
  • CI nf-test suite passes with no snapshot diffs
  • Eyeball the generated MultiQC report to confirm README/schema text changes haven't broken anchor links

- README: mark Preseq optional and add a RustQC bullet
- nextflow_schema.json: strip TODOs from kallisto_quant_fraglen[_sd]
  descriptions, clarify base-pair units, declare default false for
  skip_dupradar/qualimap/rseqc/biotype_qc/deseq2_qc, note RustQC
  supersession
- workflows/rnaseq/main.nf: bitwise & -> logical && in three skip_qc
  guards
- modules/local/deseq2_qc: replace input-dependent stub shell loop
  with deterministic touch calls
- conf/modules/featurecounts.config: drop duplicate
  CUSTOM_MULTIQCCUSTOMBIOTYPE block (kept in multiqc_custom_biotype.config)
- conf/modules/align_star.config: merge two adjacent withName blocks
  for the same selector
- bin/fastq_dir_to_samplesheet.py: remove unmaintained script
  (superseded by nf-core/fetchngs)
- ro-crate-metadata.json: refresh embedded README description
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 035fd22

+| ✅ 207 tests passed       |+
#| ❔  21 tests were ignored |#
!| ❗   7 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-05-08 11:43:07

- README: prefix the RustQC bullet with "experimental" and the "trial
  on pilot data first" caveat already used in the schema
- nextflow_schema.json: drop "RustQC supersedes this tool" from the
  four QC skip_* descriptions; replace with a shorter
  "no effect under --use_rustqc (experimental)" note
- ro-crate-metadata.json: refresh embedded README description
The module test (modules/local/deseq2_qc/tests/main.nf.test) snapshots
process.out.size_factors, which captures one per-sample
*.size_factors.RData file derived from the data columns of the input
counts. Replacing the loop with fixed sample1/sample2 touches changed
the stub output and broke the snapshot on docker and docker-arm64
shard 2.

Restore the original `for i in ...` loop and add a short comment
explaining why the stub mirrors the live-run behaviour. Drop the
"deterministic deseq2_qc stub" claim from the #1849 CHANGELOG entry.
Copy link
Copy Markdown
Contributor

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

LGTM!

@pinin4fjords
Copy link
Copy Markdown
Member Author

Thanks @vagkaratzas !

@pinin4fjords pinin4fjords merged commit 82badec into dev May 8, 2026
84 checks passed
@pinin4fjords pinin4fjords linked an issue May 11, 2026 that may be closed by this pull request
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tidy-up batch: docs, schema, configs, single trivial correctness fix

2 participants