Skip to content

stjude-rust-labs/omkit

Repository files navigation

omkit

CI: Status crates.io version crates.io downloads License: Apache 2.0 License: MIT

A cross-platform command line toolkit for omics-based analysis.
Request Feature · Report Bug · ⭐ Consider starring the repo! ⭐

Warning

Project Status: 🔴 Incubating 🔴

This tool is incubating and is not ready for production use—neither in terms of correctness nor stability. We welcome anyone to try it out and give feedback, but beware that the interface and behavior may change out from under you at any time.

🎨 Features

omkit is a command line toolkit for omics-based analysis built on top of noodles. The following features are top-level goals of the project.

  • Coming soon. The toolkit is under active development.

🖥️ Development

To bootstrap a development environment, please use the following commands.

# Clone the repository
git clone [email protected]:stjude-rust-labs/omkit.git
cd omkit

# Build the tool in release mode
cargo build --release

# Run the tool
cargo run --release -- --help

🚧️ Tests

Before submitting any pull requests, please make sure the code passes the following checks (from the root directory).

# 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

# Ensure the docs build.
cargo doc

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check the issues page.

📝 License

This project is licensed as either Apache 2.0 or MIT at your discretion. Additionally, please see the disclaimer that applies to all crates and command line tools made available by St. Jude Rust Labs.

Copyright © 2026-Present St. Jude Children's Research Hospital.

About

No description, website, or topics provided.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages