combinerCheck: Obtain Errors for metabCombiner Object Checks

View source: R/combinerCheck.R

combinerCheckR Documentation

Obtain Errors for metabCombiner Object Checks

Description

This function stores and returns a customized error message when checking the validity of certain objects.

Usage

combinerCheck(errNo, type, error = "stop")

Arguments

errNo

integer error code.

type

character object type (either "combinedTable", "metabCombiner" or "metabData")

error

character. If "stop", gives an error message; if "warning", provides a warning message; if "silent", returns silently

Details

In certain functions, an object must be checked for correctness. A metabData must have a properly formatted dataset with the correct column names & types.A metabCombiner must have properly formatted combinedTable, with expected names and columns. If one of these conditions is not met, a non-zero numeric code is returned and this function is used to print a specific error message corresponding to the appropriate object and error code.

Value

A customized error message for specific object check.


hhabra/Combiner documentation built on June 5, 2024, 10:56 a.m.