Skip to content

Welcome to qgenlib documentation

This is the documentation for the qgenlib project.

What is qgenlib?

qgenlib provides a set of classes and functions for setting up basic C++ programming environment for Hyun Min Kang. These libraries are designed with quantitative genetics in mind, but does not provide any sophisticated implementations of quantitative genetics algorithms. It is designed to be used with the htslib library. Specifically, it provides the following functionalities:

  • A macro-based command line parsing library implemented by Gonçalo Abecasis and used in many tools.
  • A collection of helper functions to output error, warning, or other messages.
  • A collection of helper functions to handle HTS file formats supported by htslib.
  • Classes and libraries to aid basic data wrangling using tab-limited files.
  • Other utility functions to handle strings.
  • A simple class to handle phred-scale quality scores.
  • A simple class to handle genomic intervals.

Documentation Overview

This documentation provides the following information:

  • Quickstart: A quick guide to get started with qgenlib.
  • Install: How to install qgenlib.
  • Examples: A simple example to demonstrate how to use qgenlib.