https://github.com/claymcleod/rge

Reference genome explorer
https://github.com/claymcleod/rge

Last synced: about 2 months ago
JSON representation

Reference genome explorer

• Host: GitHub
• URL: https://github.com/claymcleod/rge
• Owner: claymcleod
• License: apache-2.0
• Created: 2022-10-09T19:02:59.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-11T16:39:02.000Z (over 2 years ago)
• Last Synced: 2024-11-04T00:02:21.554Z (3 months ago)
• Language: Rust
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        


  


    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`.

```bash

cargo install rge

```

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

```bash

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

```

## 🖥️ Development

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

```bash

# Clone the repository

git clone [email protected]:claymcleod/rge.git

cd rge

# Run the command line tool using cargo.

cargo run -- -h

```

## 🚧️ Tests

```bash

# 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](https://github.com/claymcleod/rge/issues).

## 📝 License

Copyright © 2021-Present Clay McLeod. This project is [MIT][license-mit] or [Apache 2.0][license-apache] licensed at your discretion.

[contributing-md]: https://github.com/claymcleod/rge/blob/master/CONTRIBUTING.md

[license-mit]: https://github.com/claymcleod/rge/blob/master/LICENSE-MIT

[license-apache]: https://github.com/claymcleod/rge/blob/master/LICENSE-APACHE