-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,6 @@ | ||
# libradicl | ||
# libradicl - A library for reading parsing and writing RAD files for high-throughput genomic data | ||
|
||
Libradicl is a [Rust](https://www.rust-lang.org/) library for reading (and eventually writing and manipulating) | ||
Reduced Alignment Data (RAD) format files. These files are produced by [salmon](https://github.com/COMBINE-lab/salmon) | ||
when preparing data for single-cell quantification with [alevin-fry](https://github.com/COMBINE-lab/alevin-fry). | ||
Reduced Alignment Data (RAD) format files. These files are produced by [`piscem`](https://github.com/COMBINE-lab/piscem) and [`salmon`](https://github.com/COMBINE-lab/salmon) when preparing sc/snRNA-seq or scATAC-seq data for single-cell quantification with [`alevin-fry`](https://github.com/COMBINE-lab/alevin-fry). | ||
|
||
Currently, libradicl has primarily been developed in support of alevin-fry, so it has not been fully developed as | ||
as a general library quite yet. Eventually, we anticipate there will be a reorganization and a stabalization | ||
of the API. | ||
Currently, `libradicl` has primarily been developed in support of `alevin-fry`, though we aim for it to be a general library with a useful API for reading, writing and parsing RAD files. |