Description Usage Arguments Value
View source: R/PedSim_Functions.R
Simulate all life events for an individual and create a nuclear family, when appropriate.
1 2 | sim_nFam(found_info, stop_year, last_id, hazard_rates, NB_params, GRR,
carrier_prob, RVfounder, fert)
|
found_info |
Data.frame with 1 row. All pedigree information for the founder, must contain all fields generated by |
stop_year |
Numeric. The last year of study. If not supplied, defaults to the current year. |
last_id |
Numeric. The last id used in the pedigree. |
hazard_rates |
An object of class |
NB_params |
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, |
GRR |
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 |
carrier_prob |
Numeric. The carrier probability for all causal variants with relative-risk of disease |
RVfounder |
Logical. Indicates if all pedigrees segregate the rare, causal variant. By default, |
fert |
Numeric. A constant used to rescale the fertility rate after disease-onset. By default, |
A pedigree with updated life events for the founder, and additional information for mate and offspring, when offspring are generated.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.