#bioinformatics #genomic #read #segment #structure #parser #bases

read-structure

Library for parsing and working with read structure descriptions

2 unstable releases

0.2.1-rc.1 Jun 1, 2023
0.2.0 Jun 1, 2023
0.1.0 Mar 4, 2022

#240 in Biology


Used in fqtk

MIT license

34KB
570 lines

read-structure

Build Status license Version info

Read structures is a library for working with strings that describe how the bases in a sequencing run should be allocated into logical reads.

Each read structure is made up of one or more read segments which are in turn a segment type.

For more details see here

Documentation and Examples

Please see the generated Rust Docs.

How to use in your project

Add the following to your Cargo.toml dependencies section, updating the version number as needed.

[dependencies]
read-structure = "*"

How to build and test locally

Assuming you have cloned the repo and are in the top level:

cargo test

How to publish

This assumes that you have installed cargo-release via cargo install cargo-release and have set up credentials with crates.io.

cargo release <patch|minor|major>

Dependencies

~1–1.6MB
~30K SLoC