ClinicalExperiment-class: ClinicalExperiment: Object representing Clinical Experiment

In bnaras/SRS: Subject Randomization System

Description

A class to encapsulate a clinical experiment with its associated arms and factors. Objects can be created by calls of the form new("ClinicalExperiment", ...), although the ClinicalExperiment constructor function is recommended.The arguments include the number of factors in the experiment, the names of the factors, the number of levels of each factor, the number of treatments and the treatment names. Many, if not all, of the arguments are optional, in which case a two-treatment, two-factor experiment with two levels of each factor is assumed.

Usage

numberOfFactors(object)

## S4 method for signature 'ClinicalExperiment'
numberOfFactors(object)

factorNames(object)

## S4 method for signature 'ClinicalExperiment'
factorNames(object)

factorLevelNames(object)

## S4 method for signature 'ClinicalExperiment'
factorLevelNames(object)

numberOfTreatments(object)

## S4 method for signature 'ClinicalExperiment'
numberOfTreatments(object)

treatmentNames(object)

## S4 method for signature 'ClinicalExperiment'
treatmentNames(object)

## S4 method for signature 'ClinicalExperiment'
show(object)

Arguments

object

the ClinicalExperiment object

Slots

number.of.factors

an integer specifying the number of factors, defaults to 2

factor.names

a character vector specifying the character names, defaults to F1 and F2

number.of.factor.levels

A vector specifying the number of levels of each factor, defaults to c(2,2)

factor.level.names

a list of character vectors specifying the factor level names, defaults to F1-1, F1-2, F2-1, F2-2, etc.

number.of.treatments

the number of treatments, defaults to 2

treatment.names

the names of the treatments; defaults to c("Tr1", "Tr2")

See Also

ClinicalExperiment

Examples

showClass("ClinicalExperiment")
##
## Construct a Clinical Experiment with 3 factors, with levels 2, 2, 3
## respectively, and three treatments with default names for all.
##
expt <- ClinicalExperiment(number.of.factors = 3,
                           number.of.factor.levels = c(2, 2, 3),
                           number.of.treatments = 3)
print(expt)

bnaras/SRS documentation built on May 12, 2019, 11:26 p.m.