Changes

From Genome Analysis Wiki
Jump to navigationJump to search
1,892 bytes added ,  18:44, 14 December 2010
Line 35: Line 35:  
  ./bam --in <bamFile>.bam --out <newSamFile>.sam
 
  ./bam --in <bamFile>.bam --out <newSamFile>.sam
 
Don't forget to put in the paths to the executable and your test files.
 
Don't forget to put in the paths to the executable and your test files.
 +
 +
=== Sequence Representation ===
 +
The sequence parameter 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 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 seqEquals is specified, any matches between the sequence and the reference are represented in the sequence as '='.
 +
 +
==== Example ====
 +
ExtendedCigar: SSMMMDDMMMIMNNNMPMSSS
 +
Sequence:      AATAA  CTAGA  T AGGG
 +
Reference:      TAACCCTA ACCCT A
 +
Sequence with Orig:  AATAACTAGATAGGG
 +
Sequence with Bases:  AATAACTAGATAGGG
 +
Sequence with Equals: AA======G===GGG
 +
 +
ExtendedCigar: SSMMMDDMMMIMNNNMPMSSS
 +
Sequence:      AATGA  CTGGA  T AGGG
 +
Reference:      TAACCCTA ACCCT A
 +
Sequence with Orig:  AATGACTGGATAGGG
 +
Sequence with Bases:  AATGACTGGATAGGG
 +
Sequence with Equals: AA=G===GG===GGG
 +
 +
ExtendedCigar: SSMMMDDMMMIMNNNMPMSSS
 +
Sequence:      AAT=A  CT=GA  T AGGG
 +
Reference:      TAACCCTA ACCCT A
 +
Sequence with Orig:  AAT=ACT=GATAGGG
 +
Sequence with Bases:  AATGACTGGATAGGG
 +
Sequence with Equals: AA======G===GGG
 +
 +
ExtendedCigar: SSMMMDDMMMIMNNNMPMSSS
 +
Sequence:      AA===  ===G=  = =GGG
 +
Reference:      TAACCCTA ACCCT A
 +
Sequence with Orig:  AA======G===GGG
 +
Sequence with Bases:  AATAACTAGATAGGG
 +
Sequence with Equals: AA======G===GGG
    
=== Parameters ===
 
=== Parameters ===
 
<pre>
 
<pre>
 
     Required Parameters:
 
     Required Parameters:
         --in       : the SAM/BAM file to be read
+
         --in       : the SAM/BAM file to be read
         --out     : the SAM/BAM file to be written
+
         --out       : the SAM/BAM file to be written
 
     Optional Parameters:
 
     Optional Parameters:
         --noeof   : do not expect an EOF block on a bam file.
+
--refFile  : reference file name
         --params   : print the parameter settings
+
         --noeof     : do not expect an EOF block on a bam file.
 +
         --params   : print the parameter settings
 +
    Optional Sequence Parameters (only specify one):
 +
--seqOrig  : Leave the sequence as is (default & used if reference is not specified).
 +
--seqBases  : Convert any '=' in the sequence to the appropriate base using the reference (requires --ref).
 +
--seqEquals : Convert any bases that match the reference to '=' (requires --ref).
 
</pre>
 
</pre>
    
=== Usage ===
 
=== Usage ===
  ./bam convert --in <inputFile> --out <outputFile.sam/bam/ubam (ubam is uncompressed bam)> [--noeof] [--params]
+
  ./bam convert --in <inputFile> --out <outputFile.sam/bam/ubam (ubam is uncompressed bam)> [--refFile <reference filename>] [--seqBases|--seqEquals|--seqOrig] [--noeof] [--params]
      Line 58: Line 95:  
Number of records written = 10
 
Number of records written = 10
 
</pre>
 
</pre>
      
== dumpHeader ==
 
== dumpHeader ==

Navigation menu