Skip to content

Commit 6ff681f

Browse files
committed
docs(rustqc): tone down RustQC mentions to match experimental status
- 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
1 parent 03a19b5 commit 6ff681f

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
3. [`dupRadar`](https://bioconductor.org/packages/release/bioc/html/dupRadar.html)
5050
4. [`Preseq`](http://smithlabresearch.org/software/preseq/) (_disabled by default; enable with `--skip_preseq false`_)
5151
5. [`DESeq2`](https://bioconductor.org/packages/release/bioc/html/DESeq2.html)
52-
6. Or use [`RustQC`](https://github.com/seqeralabs/rustqc), a single-pass replacement for RSeQC, Qualimap, dupRadar, Preseq and SAMtools stats; enable with `--use_rustqc` (see usage docs).
52+
6. Or, _experimental_: [`RustQC`](https://github.com/seqeralabs/rustqc) as a single-pass alternative to RSeQC, Qualimap, dupRadar, Preseq, and SAMtools stats (enable with `--use_rustqc`; recommend trialling on pilot data first).
5353
7. Contamination detection on selected screening reads (unaligned by default); _optional_
5454
1. [`Kraken2`](https://ccb.jhu.edu/software/kraken2/) -> [`Bracken`](https://ccb.jhu.edu/software/bracken/)
5555
2. [`Sylph`](https://sylph-docs.github.io/)

nextflow_schema.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -804,25 +804,25 @@
804804
"type": "boolean",
805805
"default": false,
806806
"fa_icon": "fas fa-fast-forward",
807-
"description": "Skip dupRadar. Has no effect when `--use_rustqc` is enabled (RustQC supersedes this tool)."
807+
"description": "Skip dupRadar. Has no effect under `--use_rustqc` (experimental)."
808808
},
809809
"skip_qualimap": {
810810
"type": "boolean",
811811
"default": false,
812812
"fa_icon": "fas fa-fast-forward",
813-
"description": "Skip Qualimap. Has no effect when `--use_rustqc` is enabled (RustQC supersedes this tool)."
813+
"description": "Skip Qualimap. Has no effect under `--use_rustqc` (experimental)."
814814
},
815815
"skip_rseqc": {
816816
"type": "boolean",
817817
"default": false,
818818
"fa_icon": "fas fa-fast-forward",
819-
"description": "Skip RSeQC. Has no effect when `--use_rustqc` is enabled (RustQC supersedes this tool)."
819+
"description": "Skip RSeQC. Has no effect under `--use_rustqc` (experimental)."
820820
},
821821
"skip_biotype_qc": {
822822
"type": "boolean",
823823
"default": false,
824824
"fa_icon": "fas fa-fast-forward",
825-
"description": "Skip additional featureCounts process for biotype QC. Has no effect when `--use_rustqc` is enabled (RustQC supersedes this tool)."
825+
"description": "Skip additional featureCounts process for biotype QC. Has no effect under `--use_rustqc` (experimental)."
826826
},
827827
"skip_deseq2_qc": {
828828
"type": "boolean",

0 commit comments

Comments
 (0)