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)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. The minimum number of affected individuals in the pedigree.
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.
A list containing the following data frames:
ascertained Logical. Indicates if pedigree is ascertained.