visPed: Visualize a pedigree with cancer affection statuses and other...

Description Usage Arguments Examples

View source: R/visPed.R

Description

This function relies on the kinship2 package

Usage

1
2
3
4
5
6
visPed(
  ped,
  annot.cancers = "all",
  annot.feature = "CurAge",
  title = "Your Pedigree"
)

Arguments

ped

a pedigree that contains ID, Sex, MotherID, FatherID, isProband, CurAge It is assumed that in this data.frame, Sex = 1 if male, Sex = 0 if female and Sex = NA if unkonwn Affliction is coded in "isAffXX" columns, where XX are short names of cancers The age of diagnosis is correspondingly coded in "AgeXX" columns

annot.cancers

the cancers shortnames to display. When set to default /codeNULL, the top four cancers will be displayed.

annot.feature

ONE feature that we would get annotation from pedigree, one of the choices from c("Ancestry","Twins","CurAge","race")

title

a string for the title on the plot

Examples

1

gavin-k-lee/visPed documentation built on July 22, 2021, 1:09 p.m.