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

Please update documentation for python bindings #340

Closed chaetognatha closed 2 months ago

chaetognatha commented 8 months ago
          Well, you can use the new "[simpified python interface](http://illumina.github.io/interop/namespacecore.html)"  to read the imaging table ..
import interop as iop

run_metrics = iop.read(run_folder)

def read_imaging_table(run_metrics):
    ar = iop.imaging(run_metrics)
    df = pd.DataFrame(ar)

    # some values should be integers
    change_data_type = {
        'Lane'             : int,
        'Tile'             : int,
        'Tile Number'      : int,
        'Read'             : int,
        'Cycle'            : int,
        'Cycle Within Read': int,
        'Swath'            : int,
        'Surface'          : int
    }

    return df.astype(change_data_type)

and then plot the data accordingly. See http://illumina.github.io/interop/namespacecore.html#ab181cd004c7d8d415c5fb0b5a50f3dac

Originally posted by @sklages in https://github.com/Illumina/interop/issues/265#issuecomment-818893094

Based on current documentation it was very hard to to simply load and access the data from python, I think it may be a good idea to update the description of the python binding / simple interface and just show this quote.