ImportSim: Import an existing data frame for use with the package

Description Usage Arguments Value Examples

View source: R/import.R

Description

Import an existing data frame for use with the package

Usage

1
2
3
4
5
6
7
8
9
ImportSim(
  dejaData,
  event.times,
  status,
  study.time,
  censored.time = NULL,
  actual.events = NULL,
  allow.beyond.study = FALSE
)

Arguments

dejaData

a DejaData object contain the subject covariates and treatment arm

event.times

A list of vectors, containing the observed event times of each subject. If no events are observed then numeric(0) should be used. See example in this help file for more details

status

The status of the data set imported, either "complete" (if all subjects complete their follow up period) or "dropout" (if not)

study.time

The total follow up time according to study protocol

censored.time

If status is "dropout", this is a vector of the times at which each subject is censored

actual.events

If status is "dropout" and the total number of events (i.e. not just the number observed) is known (e.g. if a different simulation procedure was used) a vector of total number of events should be included. If the number is not known or status is "complete" then this should be set to NULL

allow.beyond.study

Whether or not to allow imported data with events after the nominal end of study.

Value

A SingleSim object

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
covar.df <- data.frame(Id=1:6,
                       arm=c(rep(0,3),rep(1,3)),
                       Z=c(0,1,1,0,1,0))
 
dejaData <- MakeDejaData(covar.df,arm="arm",Id="Id") 


event.times <- list(c(25,100,121,200,225),
                    c(100,110),c(55),numeric(0),
                    150,45)     

complete.dataset <- ImportSim(dejaData, event.times,
                    status="complete",
                    study.time=365)
 
censored.time  <- c(365,178,100,245,200,100)

dropout.dataset <- ImportSim(dejaData, event.times,
                    status="dropout",
                    study.time=365,
                    censored.time=censored.time)

dejaVu documentation built on April 27, 2021, 5:07 p.m.