Changes

From Genome Analysis Wiki
Jump to: navigation, search

BamUtil

520 bytes added, 12:57, 13 October 2010
no edit summary
<pre>
Required Parameters:
--in : the SAM/BAM file to be read --out : the SAM/BAM file to be written
Optional Parameters:
--noeof : do not expect an EOF block on a bam file. --params : print the parameter settings
</pre>
=== Usage ===
./bam convert --in <inputFile> --out <outputFile.sam/bam/ubam (ubam is uncompressed bam)> [--noeof][--params] 
=== Return Value ===
<pre>
Required Parameters:
--in : the SAM/BAM file to be split --out : the base filename for the SAM/BAM files to write into. Does not include the extension. _N will be appended to the basename where N indicates the Chromosome.
Optional Parameters:
--noeof : do not expect an EOF block on a bam file. --bamIndex : the path/name of the bam index file (if not specified, uses the --in value + ".bai") --bamout : write the output files in BAM format (default). --samout : write the output files in SAM format. --params : print the parameter settings
</pre>
=== Usage ===
./bam splitChromosome --in <inputFilename> --out <outputFileBaseName> [--bamIndex <bamIndexFile>] [--noeof] [--bamout|--samout] [--params]
=== Parameters ===
<pre>
Required Parameters: --in : the BAM file to be read --out : the SAM/BAM file to write to Optional Parameters: --noeof : do not expect an EOF block on a bam file. --bamIndex : the path/name of the bam index file (if not specified, uses the --in value + ".bai") --refName : the BAM reference Name to read (either this or refID can be specified) --refID : the BAM reference ID to read (defaults to -1: unmapped) --start : the inclusive 0-based start position (defaults to -1) --end : the exclusive 0-based end position (defaults to -1: meaning til the end of the reference) --params : print the parameter settings
</pre>
=== Usage ===
./bam writeRegion --in <inputFilename> --out <outputFilename> [--bamIndex <bamIndexFile>] [--noeof] [--refName <reference Name> | --refID <reference ID>] [--start <0-based start pos>] [--end <0-based end psoition>] [--params]
=== Return Value ===
=== Parameters ===
<pre>
Required Parameters: --in : the SAM/BAM file to be read Optional Parameters: --noeof : do not expect an EOF block on a bam file. --printRecordRefs : print the reference information for the records in the file (grouped by reference). --params : print the parameter settings
</pre>
=== Usage ===
./bam dumpRefInfo --in <inputFilename> [--noeof] [--printRecordRefs] [--params]
=== Return Value ===
=== Parameters ===
<pre>
Required Parameters: --bamIndex : the path/name of the bam index file to display Optional Parameters: --refID : the reference ID to read, defaults to print all --summary : only print a summary - 1 line per reference. --params : print the parameter settings
</pre>
=== Usage ===
./bam dumpIndex --bamIndex <bamIndexFile> [--refID <ref#>] [--summary] [--params]
=== Return Value ===
Required Parameters:
--refFile : the reference
--refName : the SAM/BAM reference Name to read (either this or refID can be specified)
--start : inclusive 0-based start position (defaults to -1)
Required Length Parameter (one but not both needs to be specified):
--end : exclusive 0-based end position (defaults to -1: meaning til the end of the reference)
--numBases : number of bases from start to display
--params : print the parameter settings
</pre>
=== Usage ===
./bam readReference --refFile <referenceFilename> --refName <reference Name>--start <0 based start> --end <0 based end>|--numBases <number of bases>[--params]
=== Return Value ===

Navigation menu