create_mate: Create a new mate

Description Usage Arguments Value

View source: R/PedSim_Functions.R

Description

Create new mating partner in pedigree.

Usage

1
create_mate(partner_info, last_id, carrier_prob, RVfounder)

Arguments

partner_info

Data.frame with 1 row. All pedigree information for the individual requiring a new mate, must contain all fields generated by create_pedFile.

last_id

Numeric. The last id used in the pedigree.

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.

Value

new_mate_info the pedigree information for the new mate.

last_id the updated value of last_id after adding the new mate.


simrvprojects/SimRVPedigree documentation built on Feb. 12, 2020, 6:12 p.m.