slow5lib

Note: Low-level API documentation is currently sparse. If something is not clear do not hesitate to open an issue.

Low-level API for reading and writing SLOW5 files

Low-level API allows much more efficient access to BLOW5 files compared to the high-level API. Following documented functions are stable.

Common

• slow5_set_log_level
      sets the level log message verbosity
• slow5_set_exit_condition
      sets if slow5lib should exit the programme on error
• slow5_idx_load_with
      loads the index file for a SLOW5 file given a file path for the index

Reading and access

• slow5_get_rids
      gets the pointer to the list of read IDs associated with a SLOW5 file
• slow5_get_hdr_keys
      gets the list of data header attribute keys
• slow5_get_aux_names
      gets the pointer to the list of auxiliary field names
• slow5_get_next_bytes
      fetches the raw record (without decompressing or parsing) at the current file pointer of a SLOW5 file
• slow5_decode
      decodes a slow5 record
• slow5_aux_get_enum
      fetches an auxiliary field of type enum from a SLOW5 record
• slow5_get_aux_enum_labels
      gets the list of labels for an enum data type

Writing and editing

• slow5_aux_add_enum
      adds an auxiliary field of type enum to a SLOW5 header
• slow5_encode
      encodes a SLOW5 record
• slow5_write_bytes
      writes an encoded SLOW5 record to a SLOW5 file

You may also refer to examples here.

If you want any other functionality than what is described above, please open a GitHub issue so such functionality exposed, rather than trying to use internal functions by browsing the code. Such undocumented functions are subject to change.