Skip to contents
-
allelic_bias_tiles()
- Shared allelic bias per tile over all cells (diagnostic)
-
allelic_features()
- Allele features per cell and region
-
allelic_noisy_tiles()
- Allelically overdispersed tiles (data-driven allelic mask)
-
annotate_arms()
- Chromosome arms and centromere flags from the Battenberg coordinate table
-
apply_thresholds()
- Apply null thresholds to scored rows
-
arm_regions()
- Arm regions from an annotated bins table
-
arm_table()
- Chromosome arms (Battenberg coordinates)
-
as_dgc()
- Coerce to a bins x cells dgCMatrix
-
assign_cells()
- Assign cells to clones by their likelihood under the clone states
-
assign_folds()
- Cross-validation folds of cells
-
assign_hstratum()
- Vote stratum of each row
-
atoms_from_regions()
- Allele atoms
-
atoms_in_tiles()
- Atoms whose start lies in the masked tiles
-
bb_loglik()
- Beta-binomial log-likelihood
-
bin_filter()
- Usable-bin flag
-
budget_threshold()
- Threshold at a false-call budget from null scores
-
budget_thresholds()
- Null thresholds at the false-call budget
-
build_layers_from_fragments()
- Build the bin-level layers from a fragment table
-
call_policy()
- Calling policy: which class x state is called at which level
-
call_pools()
- Pooled calls
-
call_scn()
- Single-cell copy-number calls of a sample
-
call_table()
- Per-cell calls table
-
caller_defaults()
- Default parameters of the copy-number caller
-
caller_normal()
- Normal-tissue copy-number caller
-
caller_params()
- Caller parameters from the caller config
-
caller_states()
- Copy-number state sets of the scorer
-
caller_tumour()
- Tumour-mode copy-number caller
-
cell_features()
- Per-cell per-region features of a sample
-
cell_piece_candidates()
- Candidate per-cell states of the MEDICC2 pieces
-
cell_piece_data()
- Per-cell evidence on the MEDICC2 pieces: depth and oriented molecule votes
-
cell_piece_states()
- Per-cell copy-number states on the MEDICC2 pieces
-
cell_qc()
- Cell QC of the caller
-
check_regions() check_votes() check_atoms() check_features() check_thresholds() check_calls() check_segments()
- Validate the caller's tables against their schemas
-
chrom_rank()
- Order chromosome names naturally (chr1..chr22, chrX, chrY, chrM, others)
-
chromatin_embedding()
- High-pass-filtered chromatin embedding (kNN neighbourhoods of the caller)
-
clean_reference()
- Clean the normal reference pool with the allele channel
-
cli_args()
- Parse
--key value and --flag arguments
-
cli_cells()
- Cell subset from a file (one cell per line or a TSV with a
cell column)
-
cli_events()
- Event regions of a sample (config
events map, region strings with 0-based half-open coordinates) as a regions table
-
cli_log()
- Timestamped message
-
cli_sample()
- Sample entry of a sample yaml (with its extraction directory)
-
cli_write()
- Write a data.table as TSV into the output directory
-
clone_allelic_distance()
- Allelic distance between clones under the all-cell orientation
-
clone_ami()
- Adjusted mutual information of two labelings
-
clone_ari()
- Adjusted Rand index of two labelings
-
clone_defaults()
- Defaults of the tumour mode
-
clone_feature_matrix()
- Cells x features matrix for clone discovery
-
clone_profiles()
- Clone pseudobulk profiles
-
clone_state_distance()
- Allelic state distance between clones
-
clone_trunks()
- Trunks of a clone set
-
cn_grid()
- Allele-specific copy-number state grid
-
collapse_molecules()
- Collapse fragments into molecules
-
consolidate_calls()
- Consolidate nested calls into events
-
contrast_data()
- Data for repeated clone contrasts
-
control_regions()
- Control regions of a tumour: pieces neutral in every clone
-
dense()
- Dense double matrix from any matrix-like
-
depth_features()
- Depth features per cell and region
-
depth_stratum()
- Depth stratum of a cell
-
detect_phasing()
- Phasing regime of a votes table
-
discover_clones()
- Discover clone leaves: smoothed PCA + Ward tree over-cut
-
discover_within()
- Clone discovery within a trunk
-
event_fdr()
- False-event accounting of a normal-mode result: p- and q-values, expected false calls and events
-
feature_windows()
- 1 Mb window depth of a precomputed features object
-
fit_allelic_null()
- Beta-binomial overdispersion of the null allele votes
-
fit_bb_rho()
- Fit the beta-binomial overdispersion on balanced (flat) counts
-
fit_clone_states()
- Fit clone copy-number states
-
fit_depth_null()
- Student-t fit of the null depth z per group
-
flag_doublet_clones()
- Flag clones that are 50:50 mixtures of two other clones
-
group_indicator()
- Aggregation matrix mapping rows (bins) to groups
-
hap_code() hap_label()
- Haplotype codes used in the fragments
hap column
-
hg38_centromeres()
- Path of the hg38 centromere table shipped with the package
-
imbalance_states()
- Allelic states
-
knn_pools()
- Chromatin-neighbourhood pools
-
ll_allelic()
- Oriented allelic log-likelihood ratio vs balanced
-
ll_depth_shift()
- Depth log-likelihood ratio of a location shift
-
locate_bins()
- Index of the bin containing each position
-
make_bins()
- Tile chromosomes into fixed-width bins
-
make_cell_meta()
- Cell metadata for the caller
-
make_pools()
- Random pools of cells within groups
-
match_depth_null()
- Per-row Student-t null parameters
-
medicc2_pieces()
- Common copy-number pieces of the clones of a tumour run (MEDICC2 export, step 1)
-
medicc2_table()
- MEDICC2 input table (MEDICC2 export, step 3)
-
merge_clones()
- Merge over-split clone leaves with a permutation-calibrated split test
-
multiplet_table()
- Multiplet table of the caller
-
new_scn()
- Construct an scn object
-
new_scphasedcn()
- The caller's result object
-
normalise_depth()
- Normalise read depth against a reference
-
null_false_calls()
- Realised false calls on the null rows of a scored table
-
null_selection_check()
- Selection-free check of the per-cell null
-
orient_blocks()
- Orient phase blocks by a leave-one-out pseudobulk
-
orient_clone_states()
- Common haplotype orientation of clone states per piece (MEDICC2 export, step 2)
-
parse_region()
- Parse a region string "chr20:28000000-" or "chr5" into a data.table
-
phasing_by_chrom()
- Phasing regime per chromosome
-
pool_scale()
- Per-region scale of pooled null scores
-
pool_scores()
- Pooled state scores
-
pooled_thresholds()
- Null thresholds of pooled scores
-
read_bins_h5ad()
- Read
bins_100kb.h5ad into an scn object (missing layers tolerated)
-
read_cells_qc()
- Read
cells_qc.tsv
-
read_chrom_sizes()
- Chromosome sizes from a FASTA index (.fai)
-
read_config()
- Read a YAML config (sample yaml or caller yaml)
-
read_fragments()
- Read fragments (whole file or tabix regions)
-
read_scphasedcn()
- Read a caller result written by
write_scphasedcn()
-
read_votes()
- Molecule votes per cell, atom and phase set
-
realised_false_calls()
- Realised false-call rates on the null rows
-
region_bin_matrix()
- Region x bin indicator under the depth (containment) rule
-
region_bins()
- Bins overlapping a set of regions
-
region_classes()
- Region classes of the caller
-
region_features()
- Per-cell depth features on arbitrary regions
-
region_set()
- The regions table of the caller
-
regions_from_features()
- Minimal regions table from a features table
-
resolve_nested()
- Resolve chromosome-level gains against depth and nested calls
-
rho_by_chrom()
- Per-chromosome allelic overdispersion, shrunk to the global
-
rho_rows()
- Per-row rho from a
rho_by_chrom() table (the global rho where the chromosome has none)
-
robust_rho()
- Robust overdispersion of null allele votes
-
scn_embedding()
- Chromatin embedding of the cells of a sample
-
score_cells()
- Per-state log-likelihood ratios and scores per cell x region
-
scphasedcn_summary()
- Headline numbers of a caller result
-
sd_class_of()
- sd_class of a region (which null regions give its per-cell null SD)
-
segment_clone()
- Segment clone profiles (Viterbi)
-
segment_pieces()
- Pieces: the union of all clone segment breakpoints
-
select_null_cells()
- Self-calibrated null cell set (normal tissue)
-
sim_events_tumour()
- Default clonal tumour events for the simulator
-
sim_genome()
- Mini genome for simulations
-
simulate_scn()
- Simulate a SPLONGGET-like single-nucleus DNA data set
-
split_alt_states()
- Alternative states of a clone segment for the disagreement split
-
split_disagree()
- Split clones whose cells disagree with the clone state on a segment
-
split_votes()
- Split molecule votes into two independent halves
-
split_win()
- Split window depth into two independent halves
-
subset_features()
- Subset a features object to a set of cells
-
subset_scn()
- Subset an scn object by cells and/or bins
-
switch_attenuation()
- Expected attenuation of the anchored imbalance by switch errors
-
tile_name()
- Tile region name
-
update_allelic_features()
- Re-aggregate the allele features of a features object without some atoms
-
vote_bins()
- Vote strata: bins of the allele votes per class x depth stratum
-
window_ids()
- Window id per bin for aggregation to a coarser grid
-
window_matrices()
- Window count matrices for clone pseudobulks
-
window_table()
- Windows table (coordinates per window id)
-
write_alleles_h5ad()
- Write the allele counts as
alleles_dna.h5ad (layers AD, DP; var = SNPs)
-
write_bins_h5ad()
- Write an scn object as
bins_100kb.h5ad (anndata layout, gzip only)
-
write_fragments()
- Write a fragments table as bgzipped TSV with a tabix index
-
write_scphasedcn()
- Write a caller result to a directory
-
write_sim_dataset()
- Write a simulated data set in the extraction-layer layout