rge

Reference genome explorer command-line tool.

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

🎨 Features

• Pseudoautosomal Region detection. Detects whether the pseudoautosomal region of chromosomes X and Y is present within the reference genome and, if so, what the coordinates of the PARs are.

📚 Getting Started

Installation

To install the latest released version, you can simply use cargo.

cargo install rge

To install the latest version on main, you can use the following command.

cargo install --locked --git https://github.com/claymcleod/rge.git

🖥️ Development

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

# Clone the repository
git clone git@github.com:claymcleod/rge.git
cd rge

# Run the command line tool using cargo.
cargo run -- -h

🚧️ Tests

# Run the project's tests.
cargo test

# Ensure the project doesn't have any linting warnirge.
cargo clippy

# Ensure the project passes `cargo fmt`.
cargo fmt --check

Minimum Supported Rust Version (MSRV)

The minimum supported Rust version for this project is 1.64.0.

🤝 Contributing

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

📝 License

Copyright © 2021-Present Clay McLeod. This project is MIT or Apache 2.0 licensed at your discretion.