SurvivalData: Constructor for 'SurvivalData' object

Description Usage Arguments Details Value See Also

View source: R/survivalData.R

Description

Constructor for SurvivalData object

Usage

1
2
3
SurvivalData(data, armDef, subjectCol, covDef = NULL, subgroupDef = NULL,
  endPointNames, censorCol, timeCol, endPointUnit = c("days", "weeks",
  "months", "years")[2])

Arguments

data

(data frame) raw data to be formatted into SurvivalData object

armDef

(columnDef object) definition of the data column that specifies the trial arm each subject was on

subjectCol

(string) name of the data column containing the unique subject identifier

covDef

(list of columnDef objects, default=NULL) definition of each required covariate, including name, type, unit, etc.

subgroupDef

(list of columnDef objects, default=NULL) definition of data columns that indicate membership of a subgroup.

endPointNames

(vector of strings) names of the endpoints

censorCol

(vector of strings) names of the data columns that specify which subjects are censored for a particular end point. The N-th element should correspond to the N-th end point.

timeCol

(vector of strings) names of the data columns that specify the times at which subjects reached a particular end point. The N-th element should correspond to the N-th end point.

endPointUnit

("days", "weeks", months" or "years" - default "months") The unit of time for the endPoint time columns

Details

See Vignette for further details

Value

A SurvivalData object

See Also

SurvivalData-class


scientific-computing-solutions/sibyl documentation built on May 21, 2019, 8:40 a.m.