Illumina / interop

C++ Library to parse Illumina InterOp files
http://illumina.github.io/interop/index.html
GNU General Public License v3.0
75 stars 26 forks source link

Documentation...? #285

Closed oakeley closed 2 years ago

oakeley commented 2 years ago

Please can you provide some basic documentation for how to use these libraries? For example:

  1. a list of available functions
  2. Examples of how to call
  3. Perhaps an example script to make some kind of useful QC report from the interop data to PDF
ezralanglois commented 2 years ago

A link to the documentation is in the upper left, see below

image

This is a good starting point: http://illumina.github.io/interop/modules.html

Only the C++ interface is documented, but the Python and C# is largely the same.

Here are some examples:

http://illumina.github.io/interop/examples.html

Sorry, I don't know much about generaring PDF reports.