addRegressor: Add an extra regressor to a Workbench

View source: R/workbench.R

addRegressorR Documentation

Add an extra regressor to a Workbench

Description

This function adds a regressor to an existing GROAN.Workbench object.

Usage

addRegressor(wb, regressor, regressor.name = regressor, ...)

Arguments

wb

the GROAN.Workbench instance to be updated

regressor

regressor function

regressor.name

string that will be used in reports. Keep in mind that when deciding names.

...

extra parameters are passed to the regressor function

Value

an updated instance of the original GROAN.Workbench

See Also

createWorkbench GROAN.run

Examples

#creating a Workbench with all default arguments
wb = createWorkbench()
#adding a second regressor
wb = addRegressor(wb, regressor = phenoRegressor.dummy, regressor.name = 'dummy')

## Not run: 
#trying to add again a regressor with the same name would result in a naming conflict error
wb = addRegressor(wb, regressor = phenoRegressor.dummy, regressor.name = 'dummy')
## End(Not run)

GROAN documentation built on Nov. 28, 2022, 5:07 p.m.