ascertainTrim_ped: Check to see if a trimmed pedigree is ascertained.

Description Usage Arguments Value

View source: R/RVPedSim_Functions.R

Description

Check to see if a trimmed pedigree is ascertained.

Usage

1
2
ascertainTrim_ped(ped_file, num_affected, first_diagnosis = NULL,
  sub_criteria = NULL)

Arguments

ped_file

Pedigree simulated by sim_ped.

num_affected

Numeric vector. The minimum number of disease-affected relatives required for ascertainment.

first_diagnosis

Numeric. The first year that reliable diagnoses can be obtained regarding disease-affection status. By default, first_diagnosis = NULL so that all diagnoses are considered reliable. See details.

Value

Logical. If TRUE, pedigree is ascertained.


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