Difference between revisions of "BamUtil: dumpHeader"
From Genome Analysis Wiki
Jump to navigationJump to search (Create dumpHeader page) |
(Add link back to bamUtil) |
||
| Line 4: | Line 4: | ||
= Overview of the <code>dumpHeader</code> function of <code>bamUtil</code> = | = Overview of the <code>dumpHeader</code> function of <code>bamUtil</code> = | ||
| − | The <code>dumpHeader</code> option on the | + | The <code>dumpHeader</code> option on the [[bamUtil]] executable prints the header of the specified SAM/BAM file to cout. |
= Parameters = | = Parameters = | ||
Revision as of 13:29, 2 September 2011
Overview of the dumpHeader function of bamUtil
The dumpHeader option on the bamUtil 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
