Skip to contents

A small synthetic dataset providing the three raw inputs required to construct a NICHESObject: a sparse expression matrix, a per-cell metadata table with spatial coordinates and cell-type labels, and a ligand–receptor database. Used by the example blocks of upstream constructors such as create_NICHESObject, compute_CellToCell, and the create_Edgelist_* family.

Format

A named list with three components:

count.mtx

50 x 80 dgCMatrix of UMI counts (genes x cells). Approximately 25% non-zero density.

meta.data

80-row data.frame with columns x, y (spatial coordinates), nCount_RNA (per-cell library size), and celltype (one of "TypeA", "TypeB", "TypeC" forming three spatial clusters). Row names are cell barcodes.

LRM.db

15-row data.frame with columns ligand, receptor, pathway. Three rows use underscore-delimited gene complexes ("GeneA_GeneB") so example output exercises the complex-handling code path.

Source

Synthetic data generated by data-raw/build_NICHESv2_example.R. Deterministic (set.seed(42)).

Details

The three components share barcodes and gene names so the standard upstream pipeline runs end-to-end without any additional data wrangling.

See also

NICHESv2_example for the prebuilt NICHESObject constructed from these inputs.

Examples

data(NICHESv2_inputs)
str(NICHESv2_inputs, max.level = 1)
#> List of 3
#>  $ count.mtx:
#> Loading required namespace: Matrix
#> Formal class 'dgCMatrix' [package "Matrix"] with 6 slots
#>  $ meta.data:'data.frame':	80 obs. of  4 variables:
#>  $ LRM.db   :'data.frame':	15 obs. of  3 variables:
dim(NICHESv2_inputs$count.mtx)
#> [1] 50 80
table(NICHESv2_inputs$meta.data$celltype)
#> 
#> TypeA TypeB TypeC 
#>    30    25    25 
head(NICHESv2_inputs$LRM.db)
#>   ligand receptor  pathway
#> 1  Gene1    Gene2 PathwayA
#> 2  Gene3    Gene4 PathwayB
#> 3  Gene5    Gene6 PathwayC
#> 4  Gene7    Gene8 PathwayD
#> 5  Gene9   Gene10 PathwayE
#> 6 Gene11   Gene12 PathwayF