sim_founderRVstatus: Determine founder genotype at the disease locus and determime...

Description Usage Arguments Value

View source: R/PedSim_Functions.R

Description

Determine founder genotype at the disease locus and determime their relative-risk of disease

Usage

1
sim_founderRVstatus(GRR, carrier_prob, RVfounder)

Arguments

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 GRR must contain one entry for each simulated subtype. See details.

carrier_prob

Numeric. The carrier probability for all causal variants with relative-risk of disease GRR. By default, carrier_prob = 0.002

RVfounder

Logical. Indicates if all pedigrees segregate the rare, causal variant. By default, RVfounder = FALSE See details.

intro_RV

Logical. If intro_RV = TRUE a founder has introduced a rare, causal variant to the pedigree, otherwise no RV has been introduced to the pedigree.

Value

A list containing: 1. the founder's genotype at the disease locus, their relative-risk of disease, and an updated value for intro_RV.


SimRVPedigree documentation built on Feb. 10, 2020, 1:07 a.m.