mangled

nf-core · Oct 30, 2024 · 60cb044 · 60cb044
2 parents eeb1577 + 5e56fc3
commit 60cb044
Show file tree

Hide file tree

Showing 22 changed files with 449 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,11 +12,10 @@ Initial release of nf-core/seqinspector, created with the [nf-core](https://nf-c
 - [#20](https://github.com/nf-core/seqinspector/pull/20) Use tags to generate group reports
 - [#13](https://github.com/nf-core/seqinspector/pull/13) Generate reports per run, per project and per lane.
 - [#49](https://github.com/nf-core/seqinspector/pull/49) Merge with template 3.0.2.
-  <<<<<<< HEAD
-- # [#40](https://github.com/nf-core/seqinspector/pull/59) Seqkit Stats TSV output.
+- [#59](https://github.com/nf-core/seqinspector/pull/59) Seqkit Stats TSV output.
+- [#50](https://github.com/nf-core/seqinspector/pull/50) Add an optional subsampling step.
 - [#51](https://github.com/nf-core/seqinspector/pull/51) Add nf-test to CI.
 - [#63](https://github.com/nf-core/seqinspector/pull/63) Contribution guidelines added about displaying results for new tools
-  > > > > > > > 1ca5e188c2fc4f501b3bb123e97ebfc743ae5b06
 
 ### `Fixed`
 

diff --git a/CITATIONS.md b/CITATIONS.md
@@ -20,7 +20,9 @@
 
 - [Seqkit](https://doi.org/10.1371/journal.pone.0163962)
 
-> Shen W, Le S, Li Y, Hu F (2016) SeqKit: A Cross-Platform and Ultrafast Toolkit for FASTA/Q File Manipulation. PLoS ONE 11(10): e0163962.
+> Wei Shen, Botond Sipos, and Liuyang Zhao. 2024. SeqKit2: A Swiss Army Knife for Sequence and Alignment Processing. iMeta e191. [doi:10.1002/imt2.191](https://doi.org/10.1002/imt2.191).
+
+- [Seqtk](https://github.com/lh3/seqtk)
 
 ## Software packaging/containerisation tools
 

diff --git a/README.md b/README.md
@@ -31,9 +31,10 @@
      workflows use the "tube map" design for that. See https://nf-co.re/docs/contributing/design_guidelines#examples for examples.   -->
 <!-- TODO nf-core: Fill in short bullet-pointed list of the default steps in the pipeline -->
 
-1. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))
-2. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))
-3. Provide Seqkit summary stats ([`SeqkitStats`](https://bioinf.shenwei.me/seqkit/usage/#stats))
+1. Subsample reads ([`Seqtk`](https://github.com/lh3/seqtk))
+2. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))
+3. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))
+4. Provide Seqkit summary stats ([`SeqkitStats`](https://bioinf.shenwei.me/seqkit/usage/#stats))
 
 ## Usage
 

diff --git a/conf/modules.config b/conf/modules.config
@@ -18,6 +18,10 @@ process {
         saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
     ]
 
+    withName: SEQTK_SAMPLE {
+        ext.args = '-s100'
+    }
+
     withName: FASTQC {
         ext.args = '--quiet'
     }

diff --git a/docs/output.md b/docs/output.md
@@ -10,11 +10,24 @@ The directories listed below will be created in the results directory after the
 
 The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes data using the following steps:
 
+- [Seqtk](#seqtk) - Subsample a specific number of reads per sample
 - [FastQC](#fastqc) - Raw read QC
 - [MultiQC](#multiqc) - Aggregate report describing results and QC from the whole pipeline
 - [SeqkitStats](#seqkitstats) - Per sample TSV file with summary statistics
 - [Pipeline information](#pipeline-information) - Report metrics generated during the workflow execution
 
+### Seqtk
+
+<details markdown="1">
+<summary>Output files</summary>
+
+- `seqtk/`
+  - `*_fastq`: FastQ file after being subsampled to the sample_size value.
+
+</details>
+
+[Seqtk](https://github.com/lh3/seqtk) samples sequences by number.
+
 ### FastQC
 
 <details markdown="1">

diff --git a/docs/usage.md b/docs/usage.md
@@ -93,6 +93,12 @@ genome: 'GRCh37'
 
 You can also generate such `YAML`/`JSON` files via [nf-core/launch](https://nf-co.re/launch).
 
+Optionally, the `sample_size` parameter allows you to subset a random number of reads to be analysed. Note that it refers to an absolute number.
+
+```bash
+nextflow run nf-core/seqinspector --input ./samplesheet.csv --outdir ./results --sample_size 1000000 -profile docker
+```
+
 ### Updating the pipeline
 
 When you run the above command, Nextflow automatically pulls the pipeline code from GitHub and stores it as a cached version. When running the pipeline after this, it will always use the cached version if available - even if the pipeline has been updated since. To make sure that you're running the latest version of the pipeline, make sure that you regularly update the cached version of the pipeline:

diff --git a/modules/nf-core/seqtk/sample/environment.yml b/modules/nf-core/seqtk/sample/environment.yml
diff --git a/modules/nf-core/seqtk/sample/main.nf b/modules/nf-core/seqtk/sample/main.nf
diff --git a/modules/nf-core/seqtk/sample/meta.yml b/modules/nf-core/seqtk/sample/meta.yml
diff --git a/modules/nf-core/seqtk/sample/tests/main.nf.test b/modules/nf-core/seqtk/sample/tests/main.nf.test
diff --git a/modules/nf-core/seqtk/sample/tests/main.nf.test.snap b/modules/nf-core/seqtk/sample/tests/main.nf.test.snap
diff --git a/modules/nf-core/seqtk/sample/tests/standard.config b/modules/nf-core/seqtk/sample/tests/standard.config
diff --git a/modules/nf-core/seqtk/sample/tests/tags.yml b/modules/nf-core/seqtk/sample/tests/tags.yml