3,045
edits
Changes
From Genome Analysis Wiki
Jump to navigationJump to searchno edit summary
= Overview of the <code>dumpIndex</code> function of <code>bamUtil</code> =
= Overview of the <code>dumpIndex</code> function of <code>bamUtil</code> =
The <code>dumpIndex</code> option on the [[bamUtil]] executable prints BAM index file in an easy to read format.
The <code>dumpIndex</code> option on the [[bamUtil]] executable prints BAM index file in an easy to read format.
= Usage =
./bam dumpIndex --bamIndex <bamIndexFile> [--refID <ref#>] [--summary] [--params]
= Parameters =
= Parameters =
--params : print the parameter settings
--params : print the parameter settings
</pre>
</pre>
{{PhoneHomeParamDesc}}
== Required Parameters ==
{{BamIndex|required=1}}
== Optional Parameters ==
=== Only dump a single Reference ID (<code>--refID</code>) ===
Use <code>--refID</code> followed by a reference ID to only print the information for that reference ID.
By default, information for all reference IDs are printed.
= Usage =
=== (<code>--summary</code>)===
Use <code>--summary</code> to print only a 1 line summary for each reference ID rather than the full output.
{{paramsParameter}}
{{PhoneHomeParameters}}
= Return Value =
= Return Value =
* 0: the BAM index file was processed successfully.
* 0: the BAM index file was processed successfully.
* non-0: the BAM index file was not processed successfully.
* non-0: the BAM index file was not processed successfully.
