Difference between revisions of "C++ Library: libStatGen"
From Genome Analysis Wiki
Jump to navigationJump to searchLine 29: | Line 29: | ||
*Use Makefile.include to build with the library. | *Use Makefile.include to build with the library. | ||
**See examples in statgen/src. | **See examples in statgen/src. | ||
+ | |||
+ | |||
+ | == Creating programs == | ||
+ | If you are creating a program, you can start with Makefile.src found at statgen/src/. | ||
+ | |||
+ | (If you are creating a program in a directory outside of statgen/src, you may need additional modifications.) | ||
+ | |||
+ | '''Example: creating statgen/src/myprog/''' | ||
+ | # cd statgen/src/myprog | ||
+ | # ln -s ../Makefile.src Makefile | ||
+ | # cp ../bam/Makefile.tool . | ||
+ | # Update Makefile.tool for your specific program. |
Revision as of 19:39, 2 December 2010
DESCRIPTION
Open source, freely available (GPL license), easy to use APIs
- File/Stream I/O – uncompressed, BGZF, GZIP, stdin, stdout
- Common file formats – SAM/BAM, FASTQ, GLF
- Indexed access to BAM files
- Accessors to get/set values
- Utility classes, including:
- Cigar – interpretation and mapping between query and reference
- Pileup – structured access to data by individual reference position
Contents
- StatGenLibrary: general - General classes for file processing and performing common tasks (used by most other libraries).
- StatGenLibrary: BAM - Classes specific for reading/writing/analyzing SAM/BAM files.
- StatGenLibrary: GLF - Classes specific for reading/writing/analyzing GLF files.
- StatGenLibrary: FASTQ - Classes specific for reading/writing/analyzing FastQ files.
Library Documentation in Doxygen
Download
To use the StatGenLibrary, first download: http://genome.sph.umich.edu/wiki/Software#Download
- Build: type make
- the library is built: statgen/lib/libStatGen.a
- Use Makefile.include to build with the library.
- See examples in statgen/src.
Creating programs
If you are creating a program, you can start with Makefile.src found at statgen/src/.
(If you are creating a program in a directory outside of statgen/src, you may need additional modifications.)
Example: creating statgen/src/myprog/
- cd statgen/src/myprog
- ln -s ../Makefile.src Makefile
- cp ../bam/Makefile.tool .
- Update Makefile.tool for your specific program.