3,045
edits
Changes
From Genome Analysis Wiki
Jump to navigationJump to searchCreate dumpHeader page
[[Category:BamUtil|dumpHeader]]
[[Category:BAM Software]]
[[Category:Software]]
= Overview of the <code>dumpHeader</code> function of <code>bamUtil</code> =
The <code>dumpHeader</code> option on the bam executable prints the header of the specified SAM/BAM file to cout.
= Parameters =
<pre>
Required Parameters:
filename : the sam/bam filename whose header should be printed.
</pre>
= 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 =
<pre>
@SQ SN:1 LN:247249719
@SQ SN:2 LN:242951149
@SQ SN:3 LN:199501827
</pre>
[[Category:BAM Software]]
[[Category:Software]]
= Overview of the <code>dumpHeader</code> function of <code>bamUtil</code> =
The <code>dumpHeader</code> option on the bam executable prints the header of the specified SAM/BAM file to cout.
= Parameters =
<pre>
Required Parameters:
filename : the sam/bam filename whose header should be printed.
</pre>
= 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 =
<pre>
@SQ SN:1 LN:247249719
@SQ SN:2 LN:242951149
@SQ SN:3 LN:199501827
</pre>
