1 ------------------------------------------------------------
3 ------------------------------------------------------------
5 BamTools: a C++ API for reading/writing BAM files.
7 The API consists of 2 main modules - BamReader and BamWriter. As you would expect,
8 BamReader provides read-access to BAM files, while BamWriter does the writing of BAM
9 files. BamReader provides an interface for random-access (jumping) in a BAM file.
11 An additional file, BamAux.h, is included as well.
12 This file contains the common data structures and typedefs used throught the API.
14 ------------------------------------------------------------
16 To use this API, you simply need to do 3 things:
18 1 - Drop the BamTools files somewhere the compiler can find them.
19 (i.e. in source directory, or somewhere in include path)
21 2 - Import BamTools API with the following lines of code
23 #include "BamReader.h" // as needed
24 #include "BamWriter.h" // as needed
25 using namespace BamTools;
27 3 - Compile with '-lz' ('l' as in 'lion') to access ZLIB compression library
29 See any included programs and Makefile for more specific compiling/usage examples.
30 See documentation & comments in header files for API details.
32 ------------------------------------------------------------
34 Feel free to contact me with any questions, comments, suggestions, bug reports, etc.
37 http://sourceforge.net/projects/bamtools