CreateNewDropoutMechanism: A function which creates a DropOut Mechanism object

Description Usage Arguments Value See Also

View source: R/DropoutMechanism.R

Description

A function which creates a DropOut Mechanism object

Usage

1
2
3
4
5
6
7
CreateNewDropoutMechanism(
  type,
  text,
  cols.needed = vector("character"),
  GetDropTime,
  parameters = NULL
)

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

Value

A DropoutMechanism.object

See Also

DropoutMechanism.object


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