checkMacroFormat: check the macro format dataset

Description Usage Arguments Details Value Author(s) See Also Examples

Description

This function is used to perform checks on the structure of the macro format dataset produced by the user-supplied macro code in analyzeData.

Usage

1

Arguments

data

(Required) Dataset to be checked to ensure it is a valid "Macro Evaluation" structure

Details

The checkMacroFormat function checks that the data passed to it is a valid "Macro Evaluation" structure. A valid "Macro Evaluation" structure is an R data frame containing only 1 row of data.

Value

Nothing. Only used for error generation side effects.

Author(s)

Mike K Smith mstoolkit@googlemail.com

See Also

analyzeData

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
  checkMacroFormat(iris[1,])
  
  ## Not run: 
    # not a data frame
    checkMacroFormat( 1:10 )
    
    # more than one row
    checkMacroFormat(iris[1:2,])
  
  
## End(Not run)

MSToolkit documentation built on May 2, 2019, 6:30 p.m.