chainfile

crates.io downloads

A crate for working with genomics chain files.
Explore the docs »

Request Feature · Report Bug · ⭐ Consider starring the repo! ⭐

## Guiding Principles This crate is written in the style of [noodles](https://github.com/zaeleus/noodles), as it was originally intended to be included as a pull request. After discussion with the maintainer of noodles, we decided this should be its own, complimentary crate. ## 📚 Getting Started To include this crate in your project, simply use the following command. ```bash cargo add chainfile ``` You can take a look at the [examples](https://github.com/stjude-rust-labs/chainfile/tree/main/examples) to get a sense of how to use the crate. ## 🖥️ Development To bootstrap a development environment, please use the following commands. ```bash # Clone the repository git clone git@github.com:stjude-rust-labs/chainfile.git cd chainfile # Build the crate in release mode cargo build --release # List out the examples cargo run --release --example ``` ## 🚧️ Tests Before submitting any pull requests, please make sure the code passes the following checks. ```bash # Run the project's tests. cargo test --all-features # Ensure the project doesn't have any linting warnings. cargo clippy --all-features # Ensure the project passes `cargo fmt`. cargo fmt --check ``` ## Minumum Supported Rust Version (MSRV) This crate is designed to work with Rust version 1.72.0 or later. It may, by happenstance, work with earlier versions of Rust. ## 🤝 Contributing Contributions, issues and feature requests are welcome! Feel free to check [issues page](https://github.com/stjude-rust-labs/chainfile/issues). ## 📝 License This project is licensed as either [Apache 2.0][license-apache] or [MIT][license-mit] at your discretion. Copyright © 2023-Present [St. Jude Children's Research Hospital](https://github.com/stjude). [license-apache]: https://github.com/stjude-rust-labs/chainfile/blob/master/LICENSE-APACHE [license-mit]: https://github.com/stjude-rust-labs/chainfile/blob/master/LICENSE-MIT