Allspice (version 1.0.7)

classify,Asset-method: Data classification

Description

Assigns category labels to new data.

Usage

classify(obj, dat, covariates)

Value

Returns a data frame that contains predicted category labels and performance indicators. The column 'CATEG' contains the final predictions, including "Unclassified" or "Ambiguous" for samples that could not be reliably classified. The columns 'MATCH.1st' and 'MATCH.2nd' contain the first and second best matching categories, respectively.

The column 'BIOMRK' contains a standardized biomarker score that indicates how similar the sample is with respect to the best-matching category. The column 'PROX' tells the likelihood of how likely it is that the observed biomarker score would have been generated by a training sample from the best-matching category (balanced group sizes). The column 'EXCL' tells the likelihood that the sample does not share characteristic features with any other category.

The returned data frame also has the attribute "biomarkers" that contains biomarker scores for all categories.

Arguments

obj

An object of the class Asset.

dat

A matrix that containts variables as rows and samples as columns.

covariates

A data.frame or matrix that containts samples as rows and covariates as columns.

Details

The input data will be automatically normalized and standardized using the internal asset parameters, see configuration() for details.

Examples

# Import ALL subtyping asset.
base <- system.file(package = "Allspice")
folder <- file.path(base, "subtypes")
a <- asset(folder)

# Simulated data.
simu <- bcellALL(5)

# Predict categories.
res <- classify(a, dat = simu$counts, covariates = simu$metadata)
print(res[,c("LABEL","PROX","EXCL")])