BamUtil: dumpRefInfo

From Genome Analysis Wiki
Revision as of 14:06, 2 September 2011 by Mktrost (talk | contribs) (Create dumpRefInfo page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Overview of the dumpRefInfo function of bamUtil

The dumpRefInfo option on the bamUtil executable prints the SAM/BAM file's reference information.

Parameters

    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

Usage

./bam dumpRefInfo --in <inputFilename> [--noeof] [--printRecordRefs] [--params]

Return Value

  • 0: the file was processed successfully.
  • non-0: the file was not processed successfully.