prepare_altexp_for_merge: Prepare an alternative experiment for merging

View source: R/merge_sce_list.R

prepare_altexp_for_mergeR Documentation

Prepare an alternative experiment for merging

Description

If the given 'altexp_name' name is missing from the SCE, a new one with all NA assays will be created.

Usage

prepare_altexp_for_merge(
  sce,
  sce_name,
  altexp_name,
  expected_assays,
  expected_features,
  batch_column,
  cell_id_column,
  retain_coldata_cols,
  preserve_rowdata_cols
)

Arguments

sce

SCE with altExp to prepare

sce_name

SCE name

altexp_name

Name of altExp of interest

expected_assays

Vector of assays that should be in each altExp

expected_features

Vector of features that should be in each altExp

batch_column

The name of the batch column which will be added to the colData slot.

cell_id_column

The name of the cell_id column which will be added to the colData slot.

retain_coldata_cols

Named list of columns that should be retained in alternative experiment colData. Each name should correspond to the alternative experiment in which it should be retained.

preserve_rowdata_cols

altExp rowData columns which should not be renamed

Value

An SCE with an updated altExp


AlexsLemonade/scpcaTools documentation built on July 12, 2024, 8:34 a.m.