BamUtil: dumpIndex
From Genome Analysis Wiki
Jump to navigationJump to search
Overview of the dumpIndex function of bamUtil
The dumpIndex option on the bamUtil executable prints BAM index file in an easy to read format.
Parameters
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
Usage
./bam dumpIndex --bamIndex <bamIndexFile> [--refID <ref#>] [--summary] [--params]
Return Value
- 0: the BAM index file was processed successfully.
- non-0: the BAM index file was not processed successfully.
