Skip to content

Commit 8f17924

Browse files
committed
doc update
1 parent b9d6173 commit 8f17924

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

docs/usage.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,18 @@ Default set to `1` and clipps off one base of the left or right side of reads. N
501501

502502
By default, nf-core/eager uses hard clipping and sets clipped bases to `N` with quality `!` in the BAM output. Turn this on to use soft-clipping instead, masking reads at the read ends respectively using the CIGAR string.
503503

504+
## Mapped reads Stripping
505+
506+
These parameters are used for removing mapped reads from orginal fastq files, usually in the context of uploading the original fastq files to a read archive (SRA/ENA)
507+
508+
### `--strip_input_fastq`
509+
510+
Create pre-Adapter Removal FASTQ files without reads that mapped to reference (e.g. for public upload of privacy sensitive non-host data)
511+
512+
### `--strip_mode`
513+
514+
Read removal mode. Strip mapped reads completely (strip) or just replace mapped reads sequence by N (replace)
515+
504516
## Library-Type Parameters
505517

506518
These parameters are required in some cases, e.g. when performing in-solution SNP capture protocols (390K,1240K, ...) for population genetics for example. Make sure to specify the required parameters in such cases.

0 commit comments

Comments
 (0)