| DropoutMechanism.object {dejaVu} | R Documentation |
DropoutMechanism object
Description
An object which defines a specific mechanism which
takes a complete SingleSim object and returns
a set of drop out times for subjects
Arguments
type |
The type of mechanism (e.g. "MCAR" or "MNAR") |
text |
A short string describing the mechanism (only used for printing) |
cols.needed |
Which columns in the SingleSim$data data frame must be included for this drop out mechanism to work. This option could allow drop out mechanism which depend on covariates to be included. |
GetDropTime |
A function with two arguments event.times and data, the corresponding entries from the SingleSim object. This function should return a list of dropout times (if a subject does not dropout its dropout time should be their current censored.time (i.e. the study follow up time)) |
parameters |
A list of named parameters for the mechanism (only used for printing) or NULL if none |
Details
It is possible to create user defined mechanisms, however, certain
common mechanisms have already been implemented. For example see
ConstantRateDrop and LinearRateChangeDrop
Only the GetDropTime and cols.needed entries are required for calculation, the other entries are used for printing the object
print.DropoutMechanism methods is defined.
Structure
The following components must be included in a DropoutMechanism Object