oxbow
| Crates.io | oxbow |
| lib.rs | oxbow |
| version | 0.4.0 |
| created_at | 2023-05-16 16:38:57.509827+00 |
| updated_at | 2025-06-13 17:52:07.298295+00 |
| description | Read conventional genomic file formats as data frames and more via Apache Arrow. |
| homepage | https://oxbow.readthedocs.io/ |
| repository | https://abdenlab.github.io/oxbow/ |
| max_upload_size | |
| id | 866209 |
| size | 488,035 |
(conradbzura)
documentation
README
oxbow
The core Rust library for oxbow.
Warning: oxbow is under active development. APIs are not yet stable and are subject to change.
Installation
To use oxbow in your Rust project, add oxbow to your Cargo.toml or run:
cargo add oxbow
Development
Ensure you have Rust installed on your system. You can install Rust using rustup.
Building the project
The oxbow Rust crate alone can be built using cargo.
cd oxbow
cargo build # --release (for non-debug build)
Linting and formatting
We use the standard Rust toolchain for linting and formatting Rust code.
Clippy is a Rust linter:
cargo clippy
The following command formats all source files of the current crate using rustfmt:
cargo fmt
Running Tests
To run tests on Rust code, we use cargo:
cargo test