create_founder: Create a new seed founder

In SimRVPedigree: Simulate Pedigrees Ascertained for a Rare Disease

Description

Create new seed founder for pedigree.

Usage

create_founder(FamID, GRR, carrier_prob, RVfounder, founder_byears)

Arguments

FamID	Numeric. The family ID to assign to the simulated pedigree.
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.
founder_byears	Numeric vector of length 2. The span of years from which to simulate, uniformly, the birth year for the founder who introduced the rare variant to the pedigree.

Value

new_founder_info the pedigree information for the new mate.

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