CheckFormula: Check formula with provided data

Description Usage Arguments Details Value

View source: R/CheckFormula.R

Description

CheckFormula is an internal function that checks formula if formula is defined in ModelMultiData.

Usage

1
CheckFormula(formula, y = NULL, groups = NULL, xName = "auto", yName = "auto")

Arguments

formula

Formula to be used in model. If provided by user, formula should include all values in yName and xName. Else, formula will be built using provided data (see details for more information).

y

A matrix containing values to be used on left-hand side of model (e.g. dependent variable). At least one of y or groups must be provided.

groups

A data.frame containing sample group data. At least one of y or groups must be provided. Column one of groups data.frame must contain sample names that correspond to column names of x and y.

xName

Names of matrices provided in x. If x is a list with named elements, defaults to list names. Else, defaults to x1, x2, ..., xn where n is the number of matrices provided in x.

yName

Name of matrix or name of column in groups to be used on left-hand of model. (see formula details for default values)

Details

Checks that user defined formula include all values in yName and xName (e.g. names of provided matrices).

Value

formula


okg3/MultiDataAnalysis documentation built on March 28, 2020, 12:20 p.m.