Skip to content

Commit 98bbf27

Browse files
Alexander PeltzerAlexander Peltzer
authored andcommitted
Update usage as well in docs
1 parent 3a52c83 commit 98bbf27

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

docs/usage.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -383,21 +383,25 @@ Turn this on to utilize BWA Mem instead of `bwa aln` for alignment. Can be quite
383383

384384
Users can configure to keep/discard/extract certain groups of reads efficiently in the nf-core/eager pipeline.
385385

386-
### `--bam_analyse_mapped_only`
386+
### `--bam_retain_unmapped`
387387

388-
This can be used to only keep mapped reads in the BAM file for downstream analysis. By default turned off, where all reads are kept in the bam file. Unmapped reads are stored both in BAM and FastQ format e.g. for different downstream processing.
388+
Specify this to keep also unmapped reads in the BAM file. This is the default setting, only mapping quality filters are applied to all reads.
389389

390-
### `--bam_discard_unmapped_entirely`
390+
### `--bam_separate_unmapped`
391391

392-
This discards all unmapped and extracted reads entirely. By default, this is turned off.
392+
Separates the mapped and unmapepd reads, keeps only mapped reads in the BAM file for downstream analysis.
393393

394-
### `--bam_keep_all`
394+
### `--bam_unmapped_to_fastq`
395395

396-
Turned on by default, keeps all reads that were mapped in the dataset.
396+
Converted unmapped reads in BAM format to compressed FastQ format.
397397

398-
### `--bam_retain_all_reads`
398+
### `--bam_discard_unmapped`
399399

400-
Specify this, if you want to filter reads for downstream analysis. This keeps all mapped and unmapped reads in the output, but allows for quality threshold filtering using `--bam_mapping_quality_threshold`.
400+
Discards unmapped reads in either FastQ or BAM format, depending on the choice of the `--bam_unmapped_rm_type`.
401+
402+
### `--bam_unmapped_rm_type`
403+
404+
Defines which unmapped read format to discard, options available are `bam` or `fastq.gz`. By default, `fastq.gz` format will be kept and `bam` will be removed.
401405

402406
### `--bam_mapping_quality_threshold`
403407

0 commit comments

Comments
 (0)