instantiate_scMinimal: Create an scMinimal object. Generally, this should be done...

View source: R/manage_scMinimal.R

instantiate_scMinimalR Documentation

Create an scMinimal object. Generally, this should be done through calling the make_new_container() wrapper function.

Description

Create an scMinimal object. Generally, this should be done through calling the make_new_container() wrapper function.

Usage

instantiate_scMinimal(
  count_data,
  meta_data,
  metadata_cols = NULL,
  metadata_col_nm = NULL
)

Arguments

count_data

sparseMatrix Matrix of raw counts with genes as rows and cells as columns

meta_data

data.frame Metadata with cells as rows and variables as columns. Number of rows in metadata should equal number of columns in count matrix.

metadata_cols

character The names of the metadata columns to use (default=NULL)

metadata_col_nm

character New names for the selected metadata columns if wish to change their names. If NULL, then the preexisting column names are used. (default=NULL)

Value

An scMinimal object holding counts and metadata for a project.

Examples

scMinimal <- instantiate_scMinimal(count_data=test_container$scMinimal_full$count_data,
meta_data=test_container$scMinimal_full$metadata)

scITD documentation built on Sept. 8, 2023, 5:11 p.m.