Changes

From Genome Analysis Wiki
Jump to navigationJump to search
304 bytes added ,  17:54, 6 January 2014
no edit summary
Line 5: Line 5:  
= Overview of the <code>dumpRefInfo</code> function of <code>bamUtil</code> =
 
= Overview of the <code>dumpRefInfo</code> function of <code>bamUtil</code> =
 
The <code>dumpRefInfo</code> option on the [[bamUtil]] executable prints the SAM/BAM file's reference information.
 
The <code>dumpRefInfo</code> option on the [[bamUtil]] executable prints the SAM/BAM file's reference information.
 +
 +
= Usage =
 +
./bam dumpRefInfo --in <inputFilename> [--noeof] [--printRecordRefs] [--params]
    
= Parameters =
 
= Parameters =
Line 15: Line 18:  
         --params          : print the parameter settings
 
         --params          : print the parameter settings
 
</pre>
 
</pre>
 +
{{PhoneHomeParamDesc}}
    +
== Required Parameters ==
 +
{{InBAMInputFile}}
   −
printRecordRefs outputs the id, the name, and the number of records with that id/name in the SAM/BAM file.  
+
== Optional Parameters ==
 +
{{noeofBGZFParameter}}
 +
 
 +
=== Print Number of Records for each Chromosome (<code>--printRecordRefs</code>) ===
 +
Use the <code>--printRecordRefs</code> option to also output each reference/chromsome id, name, and the number of records with that id/name in the SAM/BAM file.  
 
Example:
 
Example:
 
<pre>
 
<pre>
Line 24: Line 34:  
Ref ID: -1 indicates unmapped (Ref Name will be *)
 
Ref ID: -1 indicates unmapped (Ref Name will be *)
   −
= Usage =
+
{{paramsParameter}}
./bam dumpRefInfo --in <inputFilename> [--noeof] [--printRecordRefs] [--params]
+
 
 +
{{PhoneHomeParameters}}
    
= Return Value =
 
= Return Value =

Navigation menu