runArm: runArm

Description Usage Arguments Value

View source: R/main_functions.R

Description

Main function for taking and running a study arm. Provides needed settings and study object, implementing the study arm interface.

Usage

1
runArm(armDescription, study, fromDescription = T, interactive = NULL)

Arguments

armDescription

the desription slot from a DataArm object

study

A Study object.

fromDescription

Indicates if arm should be retrieved by its description or by its title.

interactive

Indicates if arm should be run in interactive mode.

Value

Returns a Study object with results from running the study arm.


biodev/packageDir documentation built on Nov. 4, 2019, 7:19 a.m.