simchildren {IHSEP}

Simulate the child events simchildren simulates the birth times of all child events spawned from an event relative the birth time of the parent event. This function is to be called by the simulator function for offspring events and is not meant for external use.

Description

Simulate the child events simchildren simulates the birth times of all child events spawned from an event relative the birth time of the parent event. This function is to be called by the simulator function for offspring events and is not meant for external use.

Usage

simchildren(br = 0.5, dis = "exp", par.dis = list(rate = 1), cens = Inf, sorted = TRUE)

Arguments

br

numerical scalar in [0,1), the branching ratio, or the expected number of direct children due to an event

dis

character string, which gives the name of the common (positive) distribution of the birth times of the child events relative to the parent event (referred to as the child birthtime distribution), such as "exp", "gamma", "weibull", etc.

par.dis

list, which gives the values of the (named) parameter(s) of the child birthtime distribution)

cens

positive scalar, which gives the censoring time (termination of observation time). The default value of Inf means no censoring.

sorted

boolean scalar, which indicates whether the out child birth times should be sorted or not. The default value is TRUE.

Value

a numeric vector of length giving the birth times of child events relative to the parent event in ascending order

See Also

simoffspring

Examples

  simchildren(br=0.9,dis="exp",par.dis=list(rate=1))