C++ Library: libStatGen

From Genome Analysis Wiki
Revision as of 17:08, 24 March 2011 by Mktrost (talk | contribs)
Jump to navigationJump to search


DESCRIPTION

Open source, freely available (GPL license), easy to use C++ APIs

  • General Operation Classes including:
    • File/Stream I/O – uncompressed, BGZF, GZIP, stdin, stdout
    • String processing
    • Parameter Parsing
  • Statistical Genetic Specific Classes including:
    • Handling Common file formats – SAM/BAM, FASTQ, GLF
      • Accessors to get/set values
      • Indexed access to BAM files
    • Utility classes, including:
      • Cigar – interpretation and mapping between query and reference
      • Pileup – structured access to data by individual reference position


Library Documentation

Latest Doxygen documentation: 3/22/11 Library Documentation in Doxygen

Version 0.1.2 Library Documentation in Doxygen

Possibly out of date documentaitons:


Using the Library

To use the StatGen Library, first download and compile via StatGen Download Instructions and StatGen Compile/Build Instructions


  • 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/

  1. cd statgen/src/myprog
  2. ln -s ../Makefile.src Makefile
  3. cp ../bam/Makefile.tool .
  4. Update Makefile.tool for your specific program.
    • You may need settings beyond were set in statgen/src/bam/Makefile.tool. See Makefile.src for what settings you can use.


Recently Added Capabilities