check_data_object: Check data object

In JCVenterInstitute/FRmatch: Cell type matching in single-cell RNA-sequencing data using FR-Match

Check data object

Description

We choose to summarize the clustered gene expression data and metadata in a data object of the SingleCellExperiment class. This function helps to check if the data object is compatible with FRmatch.

Usage

check_data_object(sce.object, verbose = TRUE)

Arguments

sce.object	Data object of the SingleCellExperiment class. See details in sce.example.
verbose	Boolean variable indicating if to print details to the console. Default: TRUE.

Details

For the FR-Match algorithm, the following data elements are essential:

• gene expression data matrix

• cell cluster membership

• informative marker genes of the reference dataset

In addition, metadata such as cluster_marker_info, f_score, cluster_order are not essential, but will facilitate visualization and more customized analyses provided in this package.

Value

A data object that passes this sanity check if no error occurs.

See Also

The SingleCellExperiment class.

JCVenterInstitute/FRmatch documentation built on Dec. 15, 2022, 2:30 p.m.