Simulate all life events for an individual and create a nuclear family, when appropriate.
sim_nFam(found_info, stop_year, last_id, hazard_rates, NB_params, GRR,
carrier_prob, RVfounder, fert)Data.frame with 1 row. All pedigree information for the founder, must contain all fields generated by create_pedFile.
Numeric. The last year of study. If not supplied, defaults to the current year.
Numeric. The last id used in the pedigree.
An object of class hazard, created by hazard.
Numeric vector of length 2. The size and probability parameters of the negative binomial distribution used to model the number of children per household. By default, NB_params = c(2, 4/7), due to the investigation of Kojima and Kelleher (1962).
Numeric. The genetic relative-risk of disease, i.e. the relative-risk of disease for individuals who carry at least one copy of the causal variant. Note: When simulating diseases with multiple subtypes GRR must contain one entry for each simulated subtype. See details.
Numeric. The carrier probability for all causal variants with relative-risk of disease GRR. By default, carrier_prob = 0.002
Logical. Indicates if all pedigrees segregate the rare, causal variant. By default, RVfounder = FALSE See details.
Numeric. A constant used to rescale the fertility rate after disease-onset. By default, fert = 1.
A pedigree with updated life events for the founder, and additional information for mate and offspring, when offspring are generated.