samtoolsSort: Sort bams by position or name

Description Usage Arguments

Description

samtools.sort sorts bam files either by position or read name using samtools sort.

Usage

1
2
samtoolsSort(bamFiles, outputFormat = "bam", sortThreads = 1,
  threads = getOption("threads", 1L), memory = "768M", sortByName = FALSE)

Arguments

bamFiles

A character vector of paths to bam files.

outputFormat

String specifying output format: ('sam'/'bam'/'cram')

sortThreads

A positive integer specifying the number of sorting and compression threads

threads

A positive integer specifying how many bams to process simultaneously.

memory

String specifying maximum memory per thread; suffix K/M/G recognized.

sortByName

Boolean. If TRUE, reads are sorted by name. If FALSE, reads are sorted by chromosome/position


dvera/gyro documentation built on May 15, 2019, 6:18 p.m.