Skip to contents

Build an object

create_NICHESObject()
Create a NICHESObject from Single-Cell Data
extract_NICHESInputs_Seurat()
Extract inputs for create_NICHESObject from a Seurat object
extract_NICHESInputs_AnnData()
Extract inputs for create_NICHESObject from an AnnData (.h5ad) file
load_LRM_database()
Load a Ligand-Receptor Pair Database
merge_NICHESObjects()
Merge multiple NICHESObjects into one

Neighborhoods and aggregation

Explore_Radius_Neighborhood()
Explore the relationship between search radius and neighborhood size
add_neighborhoods()
Add Neighborhood Slots to a NICHESObject
extract_neighborhoods()
Extract Neighborhoods from an Edge List
aggregate_NICHESObject()
Run the Full Aggregation Pipeline on a NICHESObject
add_neighborhood_edge_agg()
Add Unified Neighborhood Edge Aggregation to a NICHESObject
add_neighborhood_composition()
Add Neighborhood Cell-Type Composition to a NICHESObject

Work with an object

`[`(<NICHESObject>)
Subset a NICHESObject to a Set of Cells
print(<NICHESObject>)
Print a NICHESObject
summary(<NICHESObject>)
Summarize a NICHESObject
dim(<NICHESObject>)
Dimensions of a NICHESObject
length(<NICHESObject>)
Number of Cells in a NICHESObject
is_NICHESObject()
Test Whether an Object Is a NICHESObject
add_meta_column()
Append or Overwrite a Single Column in $cell.meta
add_cell_meta()
Replace $cell.meta on a NICHESObject
add_cell_rawcounts()
Add Raw UMI Counts to $cell.data
add_segmentation()
Attach Cell Segmentation Polygons to a NICHESObject

Export

export_to_TissuePlex()
Export a NICHESObject to TissuePlex edges.parquet

Lower-level steps

compute_CellToCell()
Compute Cell-to-Cell Ligand-Receptor Signals
create_Edgelist_Spatial()
Build a Spatial Neighborhood Edge List from 2-D Cell Coordinates
create_Edgelist_SamplingByType()
Build a Type-Stratified Sampled Edge List for Non-Spatial scRNA Data

Example data

download_NICHESv2_data()
Download a Public Tutorial Dataset
NICHESv2_inputs
Example NICHESv2 inputs (raw triple)
NICHESv2_example
Example prebuilt NICHESObject

LR databases

connectomedb2025_human
ConnectomeDB2025 ligand-receptor database – human
connectomedb2025_mouse
ConnectomeDB2025 ligand-receptor database – mouse
connectomedb2025_pig
ConnectomeDB2025 ligand-receptor database – pig
connectomedb2025_rat
ConnectomeDB2025 ligand-receptor database – rat
ncomms8866
FANTOM5 ligand-receptor database – original unfiltered table
ncomms8866_human
FANTOM5 ligand-receptor database – human
ncomms8866_mouse
FANTOM5 ligand-receptor database – mouse
ncomms8866_pig
FANTOM5 ligand-receptor database – pig
ncomms8866_rat
FANTOM5 ligand-receptor database – rat