Documentation/Tutorials

This page is the main hub for explanations and tutorials on how to use NGS++.

If you are starting out, we suggest you follow the articles in the “getting started” vignette. They will walk you through compiling and linking your first NGS++ program,and give a quick overview of what you can expect. Also, the figure to your right offers a visual representation of the internal data structure of the library.

Other vignettes are specialized for certain parts of the library. We suggest consulting these as needed. If you are looking for details on a specific function, consulting the API doc the better place to look. As time goes we will be adding supplementary vignettes, if you have suggestions or requests, please drop us a word.

NGS.001

1. Getting Started

2. Data Structures and essential functionalities

  • More on Units : The basic unit representing a genomic region
  • More on Chrom : Stores all the Units present in a given scaffold. Main functional structure.
  • More on Experiments : Stores any number of unique Chrom structures. Top-level interface used for loading data.

3. Loading and writing data

4. Data Variants

 5. Supplementary