Skip to content

API Reference

Auto-generated from source docstrings. All public functions carry NumPy-style docstrings with parameter types, return types, and at least one runnable example.

The public API surface for v1.0 consists of four functions across three modules:

Module Function Description
scsplice.io read_starsolo Ingest STARsolo SJ output
scsplice.tl make_m2 Build the M2 exclusion layer
scsplice.tl pseudo_correlation Per-event beta-binomial pseudo-R²
scsplice.pp highly_variable_events HVE selection via binomial deviance

scsplice.pl is reserved for a future plotting module; it is empty in v1.0.