findAvailAffected: Find a single person to trim from a pedigree whose is...

View source: R/findAvailAffected.R

findAvailAffectedR Documentation

Find a single person to trim from a pedigree whose is available

Description

Finds one subject from among available non-parents with indicated affection status

Usage

findAvailAffected(ped, avail, affstatus)

Arguments

ped

A pedigree objects, with id (subject ID), findex (father index), mindex (mother index)

avail

Vector of availability status (e.g., genotyped) 0/1 or TRUE/FALSE

affstatus

Vector of affection status 0/1 or TRUE/FALSE.

Details

When used within pedigree.shrink, this function is called with the first affected indicator, if the affected item in the pedigree is a matrix of multiple affected indicators.

Value

A list is returned with the following components

ped

Dataframe with trimmed subject removed

idTrimmed

Vector of IDs of trimmed individuals

isTrimmed

logical value indicating whether pedigree has been trimmed

bitSize

Bit size of the trimmed pedigree

See Also

pedigree.shrink


kinship2 documentation built on May 29, 2024, 11:14 a.m.