redicat_lib/mod.rs
1//! REDICAT: RNA Editing Cellular Assessment Toolkit
2//!
3//! REDICAT is a highly parallelized utility for analyzing RNA editing events in single-cell RNA-seq data.
4//! The library is organized into three layers:
5//!
6//! - [`core`]: Shared concurrency, IO, error, read filtering, and sparse matrix utilities
7//! - [`engine`]: High-performance processing primitives such as parallel genomic region schedulers
8//! and position data structures
9//! - [`pipeline`]: End-user workflows, including BAM-to-matrix conversion and RNA editing analysis
10//!
11//! For backwards compatibility, the legacy `call` and `bam2mtx` modules are re-exported from the
12//! new `pipeline` namespace.
13
14pub mod core;
15pub mod engine;
16pub mod pipeline;
17pub mod utils;
18
19pub use pipeline::bam2mtx;
20pub use pipeline::call;
21
22/// Convenience exports for common helpers used across binaries and downstream crates.
23pub mod prelude {
24 pub use crate::core::prelude::*;
25 pub use crate::engine::{par_granges::RegionProcessor, ParGranges};
26 pub use crate::pipeline::call::{AnnDataContainer, EditingType, ReferenceGenome};
27}