Difference between revisions of "BamUtil: splitBam"

From Genome Analysis Wiki
Jump to navigationJump to search
(Add SplitBam to Bamutil)
m (moved SplitBam to BamUtil: splitBam: Now part of BamUtil)
(No difference)

Revision as of 17:47, 16 January 2012

Overview of the splitBam function of bamUtil

The splitBam option on the bamUtil executable split a BAM file into multiple BAM files based on ReadGroup according to the following details.

  1. Creates multiple output files named [outprefix].[RGID].bam, for each ReadGroup ID (RGID) existing in the bam file
  2. Headers are a copy of the original file, removing @RG and @PG headers where IDs match with the other ReadGroup IDs.
  3. Copy each of the original file's BAM record to one of the output file where the ReadGroup ID matches


Usage

 Usage : ./bam splitBAM [-v] -i <inputBAMFile> -o <outPrefix> [-L logFile]


Parameters

Required arguments:
   -i/--in [inputBAMFile] : Original BAM file containing readGroup info
   -o/--out [outPrefix] : prefix of output bam files of [outprefix].[RGID].bam
Optional arguments:
   -L/--log [logFile]  : log file name. default is listFile.log
   -v/--verbose : turn on verbose mode