MatrixDataCheck: MatrixDataCheck: a function to check the validity of an...

In jdrudolph/PerseusR: Perseus R Interop

MatrixDataCheck: a function to check the validity of an object as a perseus data frame

Description

Check perseus compatibility of an object

Usage

MatrixDataCheck(object, ...)

## Default S3 method:
MatrixDataCheck(object = NULL, main, annotationRows,
  annotationCols, descriptions, imputeData, qualityData, all_colnames, ...)

## S3 method for class 'matrixData'
MatrixDataCheck(object, ...)

## S3 method for class 'list'
MatrixDataCheck(object, ...)

## S3 method for class 'ExpressionSet'
MatrixDataCheck(object, ...)

Arguments

object	object to check consistency with perseus data frames
...	additional arguments passed to the respective method
main	Main Data frame
annotationRows	Rows containing annotation information
annotationCols	Columns containing annotation information
descriptions	Descriptions of all the columns
imputeData	Is imputed or not
qualityData	quality number
all_colnames	The colnames to be used

Value

a logical indicating the validity of the object (or series of objects) as a perseus DF or the string of errors

NULL

NULL

NULL

Examples

require(PerseusR)

mat <- matrixData(
    main=data.frame(a=1:3, b=6:8),
    annotCols=data.frame(c=c('a','b','c')),
    annotRows=data.frame(x=factor(c('1','1'))))

MatrixDataCheck(mat)

jdrudolph/PerseusR documentation built on Sept. 10, 2022, 3:27 p.m.