BamUtil: dumpHeader

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


Overview of the dumpHeader function of bamUtil

The dumpHeader option on the bam executable prints the header of the specified SAM/BAM file to cout.

Parameters

    Required Parameters:
	filename : the sam/bam filename whose header should be printed.

Usage

./bam dumpHeader <inputFile>

Return Value

  • 0: the header was successfully read and printed.
  • non-0: the header was not successfully read or was not printed. (Returns the SamStatus.)


Example Output

@SQ	SN:1	LN:247249719
@SQ	SN:2	LN:242951149
@SQ	SN:3	LN:199501827