gestate (version 1.6.0)

RCurve-class: RCurve Class for defining recruitment distributions

Description

This class extends the Curve class, adding recruitment-related quantities such as patient numbers.

Slots

N

Total number of patients recruited.

Nactive

Number of patients recruited in active arm. Nactive+Ncontrol=N.

Ncontrol

Number of patients recruited in control arm. Nactive+Ncontrol=N.

Ratio

Randomisation ratio. Nactive divided by Ncontrol = Ratio.

Length

Total length of the recruitment period.

RF

Name of the random generator function describing the Curve.

inverse

Name of the inverse CDF function describing the Curve. Optional; set to NULL if unavailable.

paramno

Number of parameters required to define the distribution.

pnames

Names of parameters defining the distribution. Should be a vector of length paramno.

pnames

Values of parameters defining the distribution. Should be a list of length paramno.

maxF

Maximum length of patient follow-up. Typically should be Inf.

Author

James Bell

Examples

new("RCurve", type="ExampleCurve",PDF="pdf_fn_name", CDF="CDF_fn_name",
  RF="random_draw_fn_name", inverse="inv_fn_name", paramno=2, pnames=c('param1','param2'),
  pvalue=list(1,2), 
N=100,Nactive=50,Ncontrol=40, Ratio=50/40, Length = 5, maxF = Inf)