https://github.com/danielrivasmd/genomic_structures
Library for interacting with genomic structures, namely mobile elements and structural variants.
https://github.com/danielrivasmd/genomic_structures
genomics library population-genetics research-tool rust structural-variation
Last synced: 3 months ago
JSON representation
Library for interacting with genomic structures, namely mobile elements and structural variants.
- Host: GitHub
- URL: https://github.com/danielrivasmd/genomic_structures
- Owner: DanielRivasMD
- License: gpl-3.0
- Created: 2021-06-06T11:04:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T15:58:33.000Z (6 months ago)
- Last Synced: 2025-04-18T06:21:05.913Z (6 months ago)
- Topics: genomics, library, population-genetics, research-tool, rust, structural-variation
- Language: Rust
- Homepage:
- Size: 242 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
genomic_structures
Library for interacting with genomic structures, namely mobile elements and structural variants.
## Description
**genomic_structures** is a library for interting with genomic structures, namely mobile elements and structural variants.
## Installation
**genomic_structures** is written in Rust, so you'll need to grab a [Rust installation](https://rustup.rs/) in order to compile it.
To build **genomic_structures** :
```
git clone https://github.com/DanielRivasMD/genomic_structures
cd genomic_structures
cargo build --release
```
To integrate **genomic_structures** library into you code, add:
```toml
genomic_structures = "0.1"
```
to your "Cargo.toml" file. To check which element are exposed, view the documentation as indicated below.
## Testing
### Run tests
To run the test suite, use:
```
cargo test
```
## Documentation
To view the documentation, run:
```
cargo doc
```
To open the documentation in your browser, run:
```
cargo doc --open
```
## Citations
If you use **genomic_structures** or derivates in your work, please consider citing the code record.
## Contributing and Support
[](https://github.com/SciML/ColPrac)
In general contributions should follow [ColPrac](https://github.com/SciML/ColPrac). If you are interested in extending/improving **genomic_structures**, head to the [discussions](https://github.com/DanielRivasMD/genomic_structures/discussions) to reach out. For support with using genomic_structures, please open an [issue](https://github.com/DanielRivasMD/genomic_structures/issues/new/) describing the problem and steps to reproduce it.
## License
**genomic_structures** is distributed under the terms of the GNU GENERAL PUBLIC LICENSE.
See [LICENSE](LICENSE) for details.
---
**Author's Note**: This package is still under active development and is subject to change.