ascertain_ped: Determine if a pedigree is ascertained

Description Usage Arguments Value

View source: R/RVPedSim_Functions.R


Intended priamrily as an internal function, ascertain_ped checks to see if a pedigree returned by sim_ped is ascertained.


ascertain_ped(ped_file, num_affected, ascertain_span,
  recall_probs = NULL, first_diagnosis = NULL, sub_criteria = NULL)



An object of class ped. A pedigree generated by sim_ped or sim_RVped, or an object created by the function new.ped. See details.


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


Numeric vector of length 2. The year span of the ascertainment period. This period represents the range of years during which the proband developed disease and the family would have been ascertained for multiple affected relatives.


Numeric. The proband's recall probabilities for relatives, see details. If not supplied, the default value of four times kinship coefficient between the proband and the relative is used.


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.


List. Additional subtype criteria required for ascertainment. The first item in sub_criteria is expected to be a character string indicating a subtype label and the second is a numeric entry indicating the minimum number of relatives affected by the identified subtype for ascertianment. By default, sub_criteria = NULL so that no additional criteria is applied. See details.


A list containing the following data frames:

ascertained Logical. Indicates if pedigree is ascertained.

simrvprojects/SimRVPedigree documentation built on Nov. 5, 2019, 8:55 a.m.