Skip to contents

A small NICHESObject produced by running the standard upstream pipeline on NICHESv2_inputs: a spatial edge list with k = 5, ligand–receptor scoring with method = "product", and proportional normalization. Used by the example blocks of downstream functions including add_neighborhoods, add_cell_meta, and the S3 methods of NICHESObject.

Format

A NICHESObject containing 80 cells, 50 genes, 15 LRM pairs, and approximately 400 spatial edges.

Source

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

Details

Two slot families are intentionally left NULL:

  • Neighborhood slots ($neighborhood.cell.list, $neighborhood.edge.list, $neighborhood.meta) – so that add_neighborhoods examples demonstrate the actual transformation.

  • $segmentation – so that add_segmentation examples have an unsegmented starting point.

All other 11 slots are populated.

See also

NICHESv2_inputs for the raw triple of inputs; create_NICHESObject for the constructor that produces this object.

Examples

data(NICHESv2_example)
print(NICHESv2_example)
#> -- NICHESObject --------------------------------------------
#>   Cells        : 80  (80 non-empty)
#>   Genes        : 50  (50 valid)
#>   Edges        : 354  (141 non-empty)
#>   LRM pairs    : 15  (15 valid)
#>   Segmentation : none
#>   Neighborhoods: 80 cells  |  1364 edges  (mode: both_in_neighborhood, autocrine: included)
#>   Aggregations : none
#> 
#>   Slot summary:
#>     $cell.list     -- character vector of cell barcodes
#>     $cell.data     -- (cell, gene, score, score.norm) [sparse]
#>     $cell.meta     -- per-cell metadata
#>     $edge.list     -- (edge, SendingCell, ReceivingCell)
#>     $edge.data     -- (edge, LRM, score, score.norm) [sparse]
#>     $edge.meta     -- per-edge metadata with Sending/Receiving/Joint cols
#>     $neighborhood.cell.list -- named list: cell -> neighbor barcodes
#>     $neighborhood.edge.list -- named list: cell -> edge IDs
#>     $neighborhood.meta      -- (cell, n.neighbors, n.edges) [keyed]
#>     $gene.list     -- character vector of gene names
#>     $gene.meta     -- per-gene metadata
#>     $LRM.list      -- character vector of 'ligand|receptor' pairs
#>     $LRM.meta      -- per-LRM metadata
#>     $segmentation  -- sf object of cell polygons, or NULL
#>     $aggregations  -- named list of aggregation data.tables
#> ------------------------------------------------------------
dim(NICHESv2_example)
#> cells genes edges  LRMs 
#>    80    50   354    15 
length(NICHESv2_example)
#> [1] 80