isCombinedTable: Determine 'combinedTable' Validity

View source: R/combinerCheck.R

isCombinedTableR Documentation

Determine combinedTable Validity

Description

Checks whether input object is a valid metabData.Returns an integer code if invalid. Function is used alongside combinerCheck.

Usage

isCombinedTable(object)

Arguments

object

Any R object.

Details

a proper combinedTable must have these characteristics to be deemed valid for metabCombiner operations:

1) It must be a data.frame with at least 16 columns and at least 1 row

2) The first 16 columns must be named "rowID", "idx","idy","mzx","mzy","rtx", "rty", "rtProj","Qx","Qy","group","score","rankX","rankY","adductx", & "adducty" in this exact order

3) The first 16 columns must be of class: "numeric" "character","character", "numeric","numeric","numeric", "numeric", "numeric","numeric","numeric", "integer", "numeric", "integer", "integer","character", "character"

4) The group column must have no missing or negative values

Failing any one of these criteria causes an error

Value

0 if object is a valid Combiner Table; an integer code otherwise


hhabra/Combiner documentation built on Jan. 26, 2024, 10:30 p.m.