addInfo: Add metadata information to CellRouter object.

View source: R/addInfo.R

addInfoR Documentation

Add metadata information to CellRouter object.

Description

Include metadata information in the CellRouter metadata table assay@sampTab. If you have clusters identified by other algorithm, you can use this function to perform all the analysis available in CellRouter using your previously identified clusters: just select the corresponding columns in the table assay@sampTab.

Usage

addInfo(
  object,
  assay.type = "RNA",
  sample.name = "Sample1",
  metadata,
  colname,
  metadata.column = "population"
)

Arguments

object

CellRouter object.

assay.type

character; the type of data to use.

sample.name

character; the name of the tissue sample.

metadata

data frame or vector; metadata to be added.

colname

character; column name to be added to assay@sampTab in case metadata is a vector.

metadata.column

character; column to selected from the metadata to be added and included in assay@sampTab.

Value

CellRouter object with the sampTab slot updated.


edroaldo/fusca documentation built on March 1, 2023, 1:43 p.m.