create_offspring: Create a new offspring

Description Usage Arguments Value

View source: R/PedSim_Functions.R

Description

Create new offspring in pedigree.

Usage

1
create_offspring(dad_info, mom_info, byear, last_id, GRR)

Arguments

dad_info

Data.frame with 1 row. All pedigree information of offspring's father, must contain all fields generated by create_pedFile.

mom_info

Data.frame with 1 row. All pedigree information of offspring's mother, must contain all fields generated by create_pedFile.

byear

The birth year of offspring.

last_id

Numeric. The last id used in the 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.

Value

new_child_info the pedigree information for the new child

last_id the updated value of last_id after adding new offspring


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