bsxplorer2 0.2.3

A high-performance library for bisulfite sequencing data analysis and DNA methylation research
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

/// Contains data structures and logic for handling genomic annotations.
///
/// This module provides the core types for representing and storing genomic
/// features, primarily based on the GFF3 specification but also compatible
/// with BED.
///
/// The main components are:
/// - [`GffEntry`]: Represents a single feature/annotation entry from a file
///   like GFF or BED. It holds coordinate information, feature type, and
///   attributes.
/// - [`GffEntryAttributes`]: A structured representation of the key-value pairs
///   found in the GFF attributes column.
/// - [`RawGffEntry`]: An intermediate structure used for deserializing raw
///   lines from a GFF file.
/// - [`HcAnnotStore`]: A high-level data structure that stores multiple
///   [`GffEntry`] instances. It provides efficient ways to query entries by
///   genomic location using an interval tree and by parent-child relationships
///   using a tree structure.
///
/// The module also includes functionality for parsing GFF and BED files
/// into the [`HcAnnotStore`].
mod annot_store;
mod gff_entry;

pub use annot_store::{
    EntryId,
    EntryTree,
    HcAnnotStore
};
pub use gff_entry::{
    GffEntry,
    GffEntryAttributes,
    RawGffEntry,
};

#[cfg(test)]
mod tests;