Library for interacting with genomic structures, namely mobile elements and structural variants.
genomic_structures is a library for interting with genomic structures, namely mobile elements and structural variants.
genomic_structures is written in Rust, so you'll need to grab a Rust installation in order to compile it.
To build genomic_structures :
git clone https://github.com/DanielRivasMD/genomic_structures
cd genomic_structures
cargo build --release
To integrate genomic_structures library into you code, add:
genomic_structures = "0.1"to your "Cargo.toml" file. To check which element are exposed, view the documentation as indicated below.
To run the test suite, use:
cargo test
To view the documentation, run:
cargo doc
To open the documentation in your browser, run:
cargo doc --open
If you use genomic_structures or derivates in your work, please consider citing the code record.
In general contributions should follow ColPrac. If you are interested in extending/improving genomic_structures, head to the discussions to reach out. For support with using genomic_structures, please open an issue describing the problem and steps to reproduce it.
genomic_structures is distributed under the terms of the GNU GENERAL PUBLIC LICENSE.
See LICENSE for details.
Author's Note: This package is still under active development and is subject to change.