BamUtil: dumpHeader - Revision history

Mktrost at 20:50, 6 January 2014

2014-01-06T20:50:20Z

@@ Line 20: / Line 20: @@
 </pre>
-== Input File (1st Parameter) ==
+== Required Parameters ==
+{{InBAMInputFile|noParam=1st}}
 == Phone Home Parameters ==

Mktrost at 20:26, 6 January 2014

2014-01-06T20:26:35Z

@@ Line 5: / Line 5: @@
 = Overview of the <code>dumpHeader</code> function of <code>bamUtil</code> =
 The <code>dumpHeader</code> option on the [[bamUtil]] executable prints the header of the specified SAM/BAM file to cout.
 = Parameters =
@@ Line 10: / Line 14: @@
      Required Parameters:
 	filename : the sam/bam filename whose header should be printed.
 </pre>
-= Usage =
+== Input File (1st Parameter) ==
- ./bam dumpHeader <inputFile>
+=== Turn off PhoneHome (<code>--noPhoneHome</code>) ===
 = Return Value =

Mktrost: Add link back to bamUtil

2011-09-02T17:29:33Z

Add link back to bamUtil

← Older revision		Revision as of 13:29, 2 September 2011
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 ~~bam~~ executable prints the header of the specified SAM/BAM file to cout.		The <code>dumpHeader</code> option on the [[bamUtil]] executable prints the header of the specified SAM/BAM file to cout.

	= Parameters =		= Parameters =

Mktrost: Create dumpHeader page

2011-09-02T17:29:00Z

Create dumpHeader page

New 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>