3,045
edits
Changes
From Genome Analysis Wiki
Jump to navigationJump to search→Return Value
= Parameters =
= Parameters =
<pre> Required Parameters:
<pre> Required Parameters:
--in : the SAM/BAM file to be read
--out : the SAM/BAM file to be written
Optional Parameters:
--refFile : reference file name
--lshift : left shift indels when writing records
--noeof : do not expect an EOF block on a bam file
--params : print the parameter settings
--recover : attempt error recovery while reading a bam file
Optional Sequence Parameters (only specify one):
--useOrigSeq : Leave the sequence as is (default & used if reference is not specified)
--useBases : Convert any '=' in the sequence to the appropriate base using the reference (requires --refFile)
--useEquals : Convert any bases that match the reference to '=' (requires --refFile)
</pre>
</pre>
{{PhoneHomeParamDesc}}
== Required Parameters==
{{InBAMInputFile}}
{{InBAMInputFile}}
{{OutBAMOutputFile}}
{{OutBAMOutputFile}}
== Optional Parameters ==
{{refFile}}
{{refFile}}
== Left Shift Indels in the CIGAR (<code>--lshift</code>) ==
=== Left Shift Indels in the CIGAR (<code>--lshift</code>) ===
Left shift indels as far as they can go in the read.
Left shift indels as far as they can go in the read.
{{paramsParameter}}
{{paramsParameter}}
== Recover a corrupted BAM file (<code>--recover</code>) ==
=== Recover a corrupted BAM file (<code>--recover</code>) ===
See [[#BAM File Recovery |BAM File Recovery]].
See [[#BAM File Recovery |BAM File Recovery]].
== Sequence Representation Parameters (<code>--seqOrig</code>, <code>--seqBases</code>, <code>--seqEquals</code>, <code>--refFile</code>) ==
== Sequence Representation Parameters (<code>--useOrigSeq</code>, <code>--useBases</code>, <code>--useEquals</code>, <code>--refFile</code>) ==
The sequence parameters options specify how to represent the sequence if the reference is specified (refFile option).
The sequence parameters options specify how to represent the sequence if the reference is specified (refFile option).
If the reference is not specified or seqOrig is specified, no modifications are made to the sequence.
If the reference is not specified or useOrigSeq is specified, no modifications are made to the sequence.
If the reference and seqBases is specified, any matches between the sequence and the reference are represented in the sequence as the appropriate base.
If the reference and useBases is specified, any matches between the sequence and the reference are represented in the sequence as the appropriate base.
If the reference and seqEquals is specified, any matches between the sequence and the reference are represented in the sequence as '='.
If the reference and useEquals is specified, any matches between the sequence and the reference are represented in the sequence as '='.
=== Examples ===
=== Examples ===
Sequence with Equals: AA======G===GGG
Sequence with Equals: AA======G===GGG
{{PhoneHomeParameters}}
= BAM File Recovery =
= BAM File Recovery =
= 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 =
