checkCellIDArg: Check for CellID arguments

Description Usage Arguments Value

View source: R/check.R

Description

Check for CellID arguments

Usage

1
2
3
4
5
6
7
8
9
checkCellIDArg(X, group.by, reduction, dims, features, cells)

## S3 method for class 'Seurat'
checkCellIDArg(X, group.by = NULL, reduction, dims,
  features = NULL, cells = NULL)

## S3 method for class 'SingleCellExperiment'
checkCellIDArg(X, reduction, dims,
  features = NULL, cells = NULL, group.by = NULL)

Arguments

X

Seurat or SingleCell Experiment Object

group.by

Name of meta.data or ColData column.

reduction

Which dimensionality reduction to use, must be based on MCA.

dims

A vector of integers indicating which dimensions to use of specified reduction embeddings and loadings.

features

Character vector of feature names to subset feature coordinates. If not specified will take all features available from specified reduction loadings.

cells

Character vector of cell names to subset cell coordinates. If not specified will take all features available from specified reduction Embeddigns.

Value

list of corrected arguments if no error is thrown.


cbl-imagine/cellID documentation built on Nov. 12, 2019, 1:36 a.m.