BamUtil: findCigars - Revision history

Mktrost: /* Return Value */

2014-01-03T22:27:06Z

Return Value

← Older revision		Revision as of 22:27, 3 January 2014
Line 51:		Line 51:

	= Return Value =		= Return Value =
	Returns the SamStatus for the reads/writes.		Returns the SamStatus for the reads/writes (0 for success, non-0 for failure).

	= Example Output =		= Example Output =

Mktrost at 22:26, 3 January 2014

2014-01-03T22:26:42Z

@@ Line 5: / Line 5: @@
 = Overview of the <code>findCigars</code> function of <code>bamUtil</code> =
 The <code>findCigars</code> option on the [[bamUtil]] executable outputs just the reads that contain any of the specified CIGAR operations.
 = Parameters =
@@ Line 22: / Line 25: @@
 		--params     : print the parameter settings
 </pre>
-= Usage =
+== Optional General Parameters ==
 = Return Value =

Mktrost: findCigars

2011-09-02T18:54:18Z

findCigars

New page

[[Category:BamUtil|findCigars]]
[[Category:BAM Software]]
[[Category:Software]]

= Overview of the <code>findCigars</code> function of <code>bamUtil</code> =
The <code>findCigars</code> option on the [[bamUtil]] executable outputs just the reads that contain any of the specified CIGAR operations.

= Parameters =
<pre>
Required Parameters:
--in : the SAM/BAM file to be read
--out : the SAM/BAM file to be written
Optional Parameters:
--cinsert : output reads that contain insertions ('I').
--cdel : output reads that contain deletions ('D').
--cpad : output reads that contain pads ('P').
--cskip : output reads that contain skips ('N').
--chardClip : output reads that contain hard clips ('H').
--csoftClip : output reads that contain soft clips ('S').
--nonM : output reads that contain any non match/mismatch (anything other than 'M', '=', 'X')
--noeof : do not expect an EOF block on a bam file.
--params : print the parameter settings
</pre>

= Usage =
./bam findCigars --in <inputFile> --out <outputFile.sam/bam/ubam (ubam is uncompressed bam)> [--cinsert] [--cdel] [--cpad] [--cskip] [--chardClip] [--csoftClip] [--nonM] [--noeof] [--params]

= Return Value =
Returns the SamStatus for the reads/writes.

= Example Output =
<pre>

Number of records read = 10
Number of records written = 1
</pre>