|
|
| (47 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| | + | [[Category:C++]] |
| | + | [[Category:libStatGen]] |
| | + | [[Category:libStatGen BAM]] |
| | + | |
| | = SAM/BAM File= | | = SAM/BAM File= |
| | | | |
| − | [[BamFile Repository Updates]]
| + | See the github history: https://github.com/statgen/libStatGen/commits/master/bam for a list of the most recent updates to the BAM classes. |
| − | | |
| − | == Read & Write BAM/SAM Executable ==
| |
| − | When the pipeline is compiled, the sam/bam executable, "bam" is generated in the pipeline/bam/ directory.
| |
| − | | |
| − | This executable takes 2 arguments. The first argument is the input file. The second argument is the output file. The executable converts the first file into the format of the second file. So if you want to convert a Bam file to a SAM file, from the pipeline/bam/ directory you just call:
| |
| − | ./bam <bamFile>.bam <newSamFile>.sam
| |
| − | Don't forget to put in the paths to the executable and your test files.
| |
| − | | |
| − | The software reads the beginning of the input file to determine if it is SAM/BAM. To determine the format (SAM/BAM) of the output file, the software checks the output file's extension. If the extension is ".bam" it writes a BAM file, otherwise it writes a SAM file.
| |
| | | | |
| | + | [[BAM Review Action Items|Old BAM Review Action Items]] |
| | | | |
| − | == Read & Write BAM/SAM Library == | + | == Read & Write BAM/SAM Library Software == |
| − | The software for reading/writing/parsing/validating SAM/BAM files is also available in library format. The library is also found in pipeline/bam, and is called libbam.a.
| |
| | | | |
| − | This library is dependent on two other libraries, so be sure to include them all in the proper order:
| + | The software reads the beginning of files opened for reading to determine if it is SAM/BAM. To determine the format (SAM/BAM) of files open for writing, the software checks the output file's extension. If the extension is "bam" it writes a BAM file, otherwise it writes a SAM file. |
| − | <path to base pipeline directory>/libbam.a <path to base pipeline directory>/libcsg/libcsg.a <path to base pipeline directory>/thirdParty/samtools/libbam.a
| |
| | | | |
| | + | The library is found in statgen/lib/bam. |
| | | | |
| − | == Reading/Writing SAM/BAM Files In Your Program == | + | === BAM/SAM Classes === |
| − | | + | {| style="margin: 1em 1em 1em 0; background-color: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;" border="1" |
| − | === Reading/Writing Standard SAM/BAM Files ===
| + | |-style="background: #f2f2f2; text-align: center;" |
| − | The '''SamFile''' class allows a user to easily read/write a SAM/BAM file.
| + | ! Class Name !! Description |
| − | The methods found in this class are:
| |
| − | {| class="wikitable" style="width:100%" border="1" | |
| − | |+ style="font-size:150%"|'''SamFile Class Methods''' | |
| − | ! width=""|Method Name | |
| − | ! width=""|Description | |
| | |- | | |- |
| − | | bool IsEOF() | + | | <code>[[C++ Class: SamFile|SamFile]]</code> |
| − | | bool: true if the end of file has been reached, false if not. | + | | Class used for reading/writing SAM/BAM files and their headers and records. |
| | |- | | |- |
| − | | bool OpenForRead(const char* filename) | + | | <code>[[C++ Class: SamFileHeader|SamFileHeader]]</code> |
| − | | Opens the specified file for reading. | + | | Class used for storing the header. Allows access for getting and setting header values when both reading & writing SAM/BAM files. |
| − | Determines if it is a BAM/SAM file by reading the beginning of the file.
| |
| − | Returns true if successfully opened reading, false if not.
| |
| | |- | | |- |
| − | | bool OpenForWrite(const char * filename) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamHeaderRecord.html SamHeaderRecord]</code> |
| − | | bool: true if successfully opened, false if not.
| + | | Class used for storing the tag/value pairs within a given header line. |
| − | Opens as BAM file if the specified filename ends in .bam. Otherwise it is opened as a SAM file.
| |
| − | Returns true if successfully opened for writing, false if not.
| |
| | |- | | |- |
| − | | bool ReadHeader(SamFileHeader& header) | + | | <code>[[C++ Class: SamRecord|SamRecord]]</code> |
| − | | Reads the header section from the file and stores it in the passed in header.
| + | | Class used for storing a SAM/BAM Record. Allows access for getting and setting record values when both reading & writing SAM/BAM files. |
| − | Returns true if successfully read, false if not.
| |
| − | |-
| |
| − | | bool WriteHeader(const SamFileHeader& header)
| |
| − | | Writes the specified header into the file.
| |
| − | Returns true if successfully written, false if not.
| |
| − | |-
| |
| − | | bool ReadRecord(SamFileHeader& header, SamRecord& record)
| |
| − | | Reads the next record from the file and stores it in the passed in record.
| |
| − | Returns true if successfully read, false if not.
| |
| − | |-
| |
| − | | bool WriteRecord(SamFileHeader& header, SamRecord& record)
| |
| − | | Writes the specified record into the file.
| |
| − | Returns true if successfully written, false if not.
| |
| − | |}
| |
| − | | |
| − | | |
| − | ==== Usage Example ====
| |
| − | The following example reads in a sam/bam file and writes it out as a sam/bam file. The file format of the input sam/bam is determined by the SamFile class based on reading the type from the file. The file format of the output sam/bam file is determined by the '''SamFile''' class based on the extension of the output file. A ".bam" extension indicates a BAM file. All other extensions indicate SAM files.
| |
| − | <pre>
| |
| − | int main(int argc, char ** argv)
| |
| − | {
| |
| − | if(argc != 3)
| |
| − | {
| |
| − | printf("./bam <inputFile> <outputFile.sam/bam>\n");
| |
| − | exit(-1);
| |
| − | }
| |
| − | | |
| − | | |
| − | SamFile samIn;
| |
| − |
| |
| − | samIn.OpenForRead(argv[1]);
| |
| − | | |
| − | SamFile samOut;
| |
| − | | |
| − | samOut.OpenForWrite(argv[2]);
| |
| − | | |
| − | // Read the sam header.
| |
| − | SamFileHeader samHeader;
| |
| − | samIn.ReadHeader(samHeader);
| |
| − | | |
| − | samOut.WriteHeader(samHeader);
| |
| − | | |
| − | // Read the first sam record.
| |
| − | SamRecord samRecord;
| |
| − | | |
| − | // Keep reading records until the end of the file is reached.
| |
| − | int numValidRecords = 0;
| |
| − | int numRecords = 0;
| |
| − | while(!samIn.IsEOF())
| |
| − | {
| |
| − | if(samIn.ReadRecord(samHeader, samRecord) == true)
| |
| − | {
| |
| − | numRecords++;
| |
| − | // Successfully read a record from the file, so check to see
| |
| − | // if it is valid.
| |
| − | if(samRecord.isValid(samHeader))
| |
| − | {
| |
| − | // It is valid, so write it.
| |
| − | numValidRecords++;
| |
| − | samOut.WriteRecord(samHeader, samRecord);
| |
| − | }
| |
| − | }
| |
| − |
| |
| − | }
| |
| − | std::cout << "Number of records = " << numRecords << std::endl;
| |
| − | std::cout << "Number of valid records = " << numValidRecords << std::endl;
| |
| − | }
| |
| − | </pre> | |
| − | | |
| − | | |
| − | === Reading Indexed (and Sorted) BAM Files ===
| |
| − | The '''IndexedBamReader''' class allows a user to easily read BAM files that are sorted and indexed.
| |
| − | This class allows a user to read only alignments for specific reference sequence. This saves the time of having to read the entire file.
| |
| − | It takes advantage of the seeking capability of BGZF files, using the BAM Index file to determine where in the BAM file to seek to.
| |
| − | | |
| − | '''Future Enhancements''': Add the ability to read alignments that match a given start, end position for a specific reference sequence.
| |
| − | The methods found in this class are:
| |
| − | {| class="wikitable" style="width:100%" border="1"
| |
| − | |+ style="font-size:150%"|'''SamFile Class Methods'''
| |
| − | ! width=""|Method Name
| |
| − | ! width=""|Description
| |
| − | |-
| |
| − | | bool OpenForRead(const char* bamFilename, const char* bamIndexFilename)
| |
| − | | Opens the bam file for reading and reads in the corresponding index file.
| |
| − | Returns true if successfully opened, false if not.
| |
| | |- | | |- |
| − | | bool SetReadSection(int32_t refID) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamStatus.html SamStatus]</code> |
| − | | Tell the class which reference ID should be read from the BAM file. This is the index into the BAM Index list of reference information: 0 - #references. The records for that reference id will be retrieved on each ReadRecord call. When all records have been retrieved for the specified reference id, ReadRecord will return false until a new read section is set. | + | | Status value used by the BAM classes for returning the status of the operations. |
| − | Pass in -1 in order to read the section of the bam file not associated with any reference ID.
| |
| − | Returns true if the read section was successfully set, false if not.
| |
| | |- | | |- |
| − | | bool ReadRecord(SamFileHeader& header, SamRecord& record) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamValidator.html SamValidator]</code> |
| − | | Reads the next record from the file and stores it in the passed in record. Only alignments in the section specified by SetReadSection are read. If they have all already been read, this method returns false. If SetReadSection has not been called, then the entire file is read.
| + | | Validates a SAM/BAM Record. |
| − | Returns true if successfully read, false if not.
| |
| | |- | | |- |
| − | | bool IsEOF() | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamValidationError.html SamValidationError]</code> |
| − | | While this is available, if you are only reading a specific reference sequence, you may never hit the end of the file, so be careful using this method. | + | | Validation Error Information for a SamRecord. |
| − | bool: true if the end of file has been reached, false if not.
| |
| | |- | | |- |
| − | | bool OpenForRead(const char* filename) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamValidationErrors.html SamValidationErrors]</code> |
| − | | This method exists, but does not do anything and just returns false. You cannot open a file without an associated index file.
| + | | Container for ValidationErrors. |
| − | Returns false.
| |
| | |- | | |- |
| − | | bool OpenForWrite(const char * filename) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classPileup.html Pileup]</code> |
| − | | This method exists, but does not do anything and just returns false. This class is only for reading. | + | | Template for doing pileups. |
| − | Returns false.
| |
| | |- | | |- |
| − | | bool ReadHeader(SamFileHeader& header) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classPileupElement.html PileupElement]</code> |
| − | | Reads the header section from the file and stores it in the passed in header.
| + | | Base class that can be used for the elements stored in a Pileup. |
| − | Returns true if successfully read, false if not.
| |
| − | |-
| |
| − | | bool WriteHeader(const SamFileHeader& header)
| |
| − | | This method exists, but does not do anything and just returns false. This class is only for reading.
| |
| − | Returns false.
| |
| − | |-
| |
| − | | bool WriteRecord(SamFileHeader& header, SamRecord& record)
| |
| − | | This method exists, but does not do anything and just returns false. This class is only for reading.
| |
| − | Returns false.
| |
| − | |}
| |
| − | | |
| − | | |
| − | ==== Usage Example ====
| |
| − | This example reads in the inputFilename bam file and writes it back out section by section to the specified outputFilename, starting with section -1. It also prints a count of the number of records in each section.
| |
| − | <pre> | |
| − | int ReadIndexedBam(const char* inputFilename,
| |
| − | const char* outputFilename,
| |
| − | const char* indexFilename)
| |
| − | {
| |
| − | IndexedBamReader samIn;
| |
| − |
| |
| − | samIn.OpenForRead(inputFilename, indexFilename);
| |
| − | | |
| − | SamFile samOut;
| |
| − | | |
| − | samOut.OpenForWrite(outputFilename);
| |
| − | | |
| − | // Read the sam header.
| |
| − | SamFileHeader samHeader;
| |
| − | samIn.ReadHeader(samHeader);
| |
| − | // Write the sam header.
| |
| − | samOut.WriteHeader(samHeader);
| |
| − | | |
| − | SamRecord samRecord;
| |
| − |
| |
| − | int numValidRecords = 0;
| |
| − | int numRecords = 0;
| |
| − | | |
| − | // Loop through each Reference.
| |
| − | for(int i = -1; i < 23; i++)
| |
| − | {
| |
| − | int numSectionRecords = 0;
| |
| − | samIn.SetReadSection(i);
| |
| − | // Keep reading records until they aren't read successfully.
| |
| − | while(samIn.ReadRecord(samHeader, samRecord) == true)
| |
| − | {
| |
| − | numSectionRecords++;
| |
| − | numRecords++;
| |
| − | // Successfully read a record from the file, so check to see
| |
| − | // if it is valid.
| |
| − | if(samRecord.isValid(samHeader))
| |
| − | {
| |
| − | // It is valid, so write it.
| |
| − | numValidRecords++;
| |
| − | samOut.WriteRecord(samHeader, samRecord);
| |
| − | }
| |
| − | }
| |
| − | std::cout << "Reference ID " << i << " has " << numSectionRecords
| |
| − | << " records" << std::endl;
| |
| − | }
| |
| − |
| |
| − | std::cout << "Number of records = " << numRecords << std::endl;
| |
| − | std::cout << "Number of valid records = " << numValidRecords << std::endl;
| |
| − | | |
| − | return(0);
| |
| − | }
| |
| − | </pre> | |
| − | | |
| − | | |
| − | == Setting fields in a SAM/BAM Header ==
| |
| − | The '''SamRecord''' class contains accessors to set the header lines of a SAM/BAM header. By using these set methods to setup the header, they can be pulled back out using the get accessors or the header can be later written to a SAM/BAM file.
| |
| − | The methods found in the '''SamFileHeader''' class for setting fields are:
| |
| − | {| class="wikitable" style="width:100%" border="1"
| |
| − | |+ style="font-size:150%"|'''SamFileHeader Class Methods'''
| |
| − | ! width=""|Method Name
| |
| − | ! width=""|Description
| |
| − | |-
| |
| − | | bool addHeaderLine(const char* type, const char* tag, int value)
| |
| − | | Adds the type, tag, and integer value to the header.
| |
| − | Returns true if successfully added, false if not.
| |
| − | NOTE: currently, this method will only do one tag per type on a line. If a type has multiple tags, then the whole line needs to be added at once.
| |
| − | |-
| |
| − | | bool addHeaderLine(const char* type, const char* tag, const char* value)
| |
| − | | Adds the type, tag, and const char* value to the header.
| |
| − | Returns true if successfully added, false if not.
| |
| − | NOTE: currently, this method will only do one tag per type on a line. If a type has multiple tags, then the whole line needs to be added at once.
| |
| − | |-
| |
| − | | bool addHeaderLine(const char* headerLine)
| |
| − | | Adds the already setup/formatted headerLine to the header. It is assumed that the line does not contain a “\n”.
| |
| − | Returns true if successfully added, false if not.
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | | |
| − | == Setting fields in a SAM/BAM Record ==
| |
| − | The '''SamRecord''' class contains accessors to set the fields of a SAM/BAM record. They are used for creating a record that is not read from a SAM/BAM file. By using these set methods to setup the record, they can be pulled back out using the get accessors or the record can be later written as either a SAM/BAM record.
| |
| − | The methods found in the '''SamRecord''' class for setting fields are:
| |
| − | {| class="wikitable" style="width:100%" border="1"
| |
| − | |+ style="font-size:150%"|'''SamRecord Class Methods'''
| |
| − | ! width=""|Method Name
| |
| − | ! width=""|Description
| |
| | |- | | |- |
| − | | void resetRecord() | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classErrorHandler.html ErrorHandler]</code> |
| − | | Resets the record to be an empty record. This is not necessary when you are reading a Sam/Bam file, but if you are setting fields, it is a good idea to clean out a record before reusing it. Clearing it allows you to not have to set any empty fields. | + | | Class for handling errors based on the error handling type. |
| | |- | | |- |
| − | | bool setReadName(const char* readName) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classPosList.html PosList]</code> |
| − | | Sets QNAME to the passed in name. | + | | Store refID/position, but does not store values < 0. |
| − | Returns true if successfully set, false if not.
| |
| | |- | | |- |
| − | | bool setFlag(int flag) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamFilter.html SamFilter]</code> |
| − | | Sets the bitwise FLAG to the passed in value. | + | | Class for filtering a SAM/BAM record. |
| − | Returns true if successfully set, false if not.
| |
| | |- | | |- |
| − | | bool setReferenceName(SamFileHeader& header, const char* referenceName) | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamFlag.html SamFlag]</code> |
| − | | Sets the reference sequence name. The reference id is calculated using the header.
| + | | Class for getting information from a SAM/BAM flag. |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool set1BasedPosition(int position)
| |
| − | | Sets the leftmost position. The value passed in is 1-based (SAM formatted). Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool set0BasedPosition(int position)
| |
| − | | Sets the leftmost position. The value passed in is 0-based (BAM formatted). Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | |bool setMapQuality(int mapQuality)
| |
| − | | Sets the mapping quality.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool setCigar(const char* cigar)
| |
| − | | Sets the cigar string to the passed in CIGAR. This is a SAM formatted CIGAR string. Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool setMateReferenceName(SamFileHeader& header, const char* referenceName)
| |
| − | | Sets the mate reference sequence name. The mate reference id is calculated using the header.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool set1BasedMatePosition(int matePosition)
| |
| − | | Sets the leftmost mate position. The value passed in is 1-based (SAM formatted). Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool set0BasedMatePosition(int matePosition)
| |
| − | | Sets the leftmost mate position. The value passed in is 0-based (BAM formatted). Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |- | |
| − | | bool setInsertSize(int insertSize)
| |
| − | | Sets the inferred insert size.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool setSequence(const char* seq)
| |
| − | | Sets the sequence string to the passed in string. This is a SAM formatted sequence string. Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool setQuality(const char* quality)
| |
| − | | Sets the quality string to the passed in string. This is a SAM formatted quality string. Internal processing handles switching between SAM/BAM formats when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |-
| |
| − | | bool addTag(const char* tag, char vtype, const char* value)
| |
| − | | Adds a tag to the record with the specified tag, vtype, and value. Vtype can be SAM/BAM vtype. Internal processing handles switching between SAM/BAM vtypes when read/written.
| |
| − | Returns true if successfully set, false if not.
| |
| − | |}
| |
| − | | |
| − | When set, SAM fields are validated against: [[SAM Validation Criteria]]
| |
| − | | |
| − | | |
| − | == Retrieving fields from a SAM/BAM Record ==
| |
| − | The '''SamRecord''' class contains accessors to access the fields of a SAM/BAM record. They assume that the class has already been populated, either by using the set commands or by calling SamFile::ReadRecord. Not all of the values that can be retrieved using these get accessors have set methods. That is because they are internally calculated values if they were not read from a file.
| |
| − | | |
| − | The methods found in the SamRecord class for setting fields are:
| |
| − | {| class="wikitable" style="width:100%" border="1"
| |
| − | |+ style="font-size:150%"|'''SamRecord Class Get Methods'''
| |
| − | ! width=""|Method Name
| |
| − | ! width=""|Description
| |
| − | |-
| |
| − | | bool isValid(SamFileHeader& header)
| |
| − | | Returns true if the record is valid. This performs validation steps. TODO: the method exists, but it does not yet perform any checks, so just returns true.
| |
| − | |-
| |
| − | | int getBlockSize()
| |
| − | | Returns the BAM block size of the record.
| |
| − | |-
| |
| − | | const char* getReferenceName()
| |
| − | | Returns the reference sequence name (SAM format).
| |
| − | |-
| |
| − | | int getReferenceID()
| |
| − | | Returns the reference sequence ID (BAM format).
| |
| − | |-
| |
| − | | int get1BasedPosition()
| |
| − | | Returns the 1-based (SAM formatted) leftmost position.
| |
| − | |-
| |
| − | | int get0BasedPosition()
| |
| − | | Returns the 0-based (BAM formatted) leftmost position.
| |
| − | |-
| |
| − | | int getReadNameLength()
| |
| − | | Returns the length of the ReadName (QNAME).
| |
| − | |-
| |
| − | | int getMapQuality()
| |
| − | | Returns the map quality.
| |
| − | |-
| |
| − | | int getBin()
| |
| − | | Returns the BAM bin for the record.
| |
| − | |-
| |
| − | | int getCigarLength()
| |
| − | | Returns the length of the CIGAR in BAM format.
| |
| − | |-
| |
| − | | int getFlag()
| |
| − | | Returns the flag.
| |
| − | |-
| |
| − | | int getReadLength()
| |
| − | | Returns the length of the read.
| |
| − | |-
| |
| − | | const char* getMateReferenceName()
| |
| − | | Returns the mate reference sequence name (SAM format). Returns the mate reference sequence name even if it is the same as the reference sequence name.
| |
| − | |-
| |
| − | | const char* getMateReferenceNameOrEqual()
| |
| − | | Returns the mate reference sequence name (SAM format). Returns the mate reference sequence name, unless it is the same as the reference sequence name, then an "=" is returned..
| |
| − | |-
| |
| − | | int getMateReferenceID()
| |
| − | | Returns the mate reference sequence id (BAM format).
| |
| − | |-
| |
| − | | int get1BasedMatePosition()
| |
| − | | Returns the 1-based (SAM formatted) mate leftmost position.
| |
| − | |-
| |
| − | | int get0BasedMatePosition()
| |
| − | | Returns the 0-based (BAM formatted) mate leftmost position.
| |
| − | |-
| |
| − | | int getInsertSize()
| |
| − | | Returns the insert size.
| |
| − | |-
| |
| − | | const char* getReadName()
| |
| − | | Returns the SAM formatted Read Name (QNAME).
| |
| − | |-
| |
| − | | const char* getCigar()
| |
| − | | Returns the SAM formatted CIGAR string.
| |
| − | |-
| |
| − | | const char* getSequence()
| |
| − | | Returns the SAM formatted Sequence string.
| |
| − | |-
| |
| − | | const char* getQuality()
| |
| − | | Returns the SAM formatted Quality string.
| |
| − | |-
| |
| − | | bool getNextSamTag(char* tag, char& vtype, void** value)
| |
| − | | Returns true if a tag was read, false if there are no more tags.
| |
| − | For a true return value, tag is sent to the tag of the tag, vtype is set to the vtype of the tag, and value is a pointer to the value of the tag. You will then need to use a switch to cast value to int, double, char, or String.
| |
| − | |-
| |
| − | | bool isIntegerType(char vtype)
| |
| − | | Returns true if the passed in vtype is of integer ('c', 'C', 's', 'S', 'i', 'I') type.
| |
| − | |-
| |
| − | | bool isDoubleType(char vtype)
| |
| − | | Returns true if the passed in vtype is of double ('f') type.
| |
| − | |-
| |
| − | | bool isCharType(char vtype)
| |
| − | | Returns true if the passed in vtype is of char ('A') type.
| |
| − | |-
| |
| − | | bool isStringType(char vtype)
| |
| − | | Returns true if the passed in vtype is of String ('Z') type.
| |
| | |- | | |- |
| | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamReferenceInfo.html SamReferenceInfo]</code> |
| | + | | Class for tracking the reference information mapping between the reference ids and the reference names. |
| | |- | | |- |
| | + | | <code>[http://csg.sph.umich.edu//mktrost/doxygen/current/classSamTags.html SamTags]</code> |
| | + | | Class for parsing/creating/operating on SAM/BAM record tags. |
| | |} | | |} |
| | | | |
| | + | == FAQs == |
| | + | [[SAM/BAM Classes FAQs]] |
| | | | |
| − | Example of using getNextSamTag:
| + | == Usage Examples == |
| − | <pre>
| + | [[Sam Library Usage Examples]] |
| − | // record is a previously setup SamRecord.
| |
| − | String recordString = "";
| |
| − | char tag[3];
| |
| − | char vtype;
| |
| − | void* value;
| |
| − | | |
| − | // While there are more tags, write them to the recordString.
| |
| − | while(record.getNextSamTag(tag, vtype, &value) != false)
| |
| − | {
| |
| − | recordString += "\t";
| |
| − | recordString += tag;
| |
| − | recordString += ":";
| |
| − | recordString += vtype;
| |
| − | recordString += ":";
| |
| − | if(record.isIntegerType(vtype))
| |
| − | {
| |
| − | recordString += (int)*(int*)value;
| |
| − | }
| |
| − | else if(record.isDoubleType(vtype))
| |
| − | {
| |
| − | recordString += (double)*(double*)value;
| |
| − | }
| |
| − | else if(record.isCharType(vtype))
| |
| − | {
| |
| − | recordString += (char)*(char*)value;
| |
| − | }
| |
| − | else
| |
| − | {
| |
| − | // String type.
| |
| − | recordString += (String)*(String*)value;
| |
| − | }
| |
| − | }
| |
| | | | |
| − | recordString += "\n";
| |
| − | </pre>
| |
| | | | |
| | + | == Programs == |
| | | | |
| − | == Suggested Improvements/Features ==
| + | BamUtil contains a set of programs that uses this library to operate on SAM & BAM files. It includes tools for converting between SAM & BAM and validating the files. See [[BamUtil]] for more information and a description of all the tools. |
| − | * Add optional user flag for checking if a file is sorted when it is read. It would report an error if it is unsorted.
| |
