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.
1. Getting Started
- Linking your first NGS++ program
- Writing your first NGS++ program
- Introduction to the main NGS++ data structures
- Introduction to data reading and writing
- Introduction to NGS++ data variants
- C++ 11 primer
- Predicates and functional operators
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
- The Parser object : Used to read data from various genomic file formats.
- The Writer object : Use to write transformed data to various file formats.
- The Token object : Intermediate structure, essential to the functioning of the Parser/Writer objects.
- Supported formats and their specificities : Overal list of supported formats
4. Data Variants
- The uTags variant : Mostly used for SAM style data
- The uRegion variant : Used when you need a bit more information on a region, including density signals
- The uGene variant : Used when working with genomic regions that have sub-features ( eg: A gene with a promoter )