Check compatibility of a sample key with a supplied object

Share:

Description

For many gCrisprTools functions, a sample key must be provided that specifies sample mapping to experimental groups and specifies which of these contains control samples. This function checks whether the specified sample key is of the proper format and has properties consistent matching the specified object.

Usage

1
ct.inputCheck(sampleKey, object)

Arguments

sampleKey

A named factor, where the levels indicate the experimental replicate groups and the names match the colnames of the expression matrix contained in object. The first level should correspond to the control samples, but obviously there is no way to algorithmically control this.

object

An ExpressionSet, EList, or matrix.

Value

A logical indicating whether the objects are compatible.

Author(s)

Russell Bainer

Examples

1
2
3
4
5
6
7
8
data('es')
library(limma)
library(Biobase)

#Build the sample key
sk <- relevel(as.factor(pData(es)$TREATMENT_NAME), "ControlReference")
names(sk) <- row.names(pData(es))
ct.inputCheck(sk, es)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.