visEngine: Visualization engine inspired by kinship2

Description Usage Arguments

View source: R/visPed.R

Description

Visualization engine inspired by kinship2

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
visEngine(
  x,
  annot,
  feature.name = NULL,
  which.proband = NULL,
  add.ids = x$id[x$add == 1],
  id = x$id,
  status = x$status,
  affected = x$affected,
  cex = 1,
  col = 1,
  symbolsize = 1,
  branch = 0.6,
  packed = TRUE,
  align = c(1.5, 2),
  width = 10,
  density = c(-1, 35, 65, 20),
  main_title = "Your Pedigree",
  mar = c(4.1, 1, 4.1, 1),
  angle = c(90, 65, 40, 0),
  keep.par = FALSE,
  subregion,
  pconnect = 0.5
)

Arguments

x

a pedigree data.frame

annot

the annotation string

feature.name

the names of the features

which.proband

which ID is the proband

add.ids

which additional IDs to add

id

ID column from x pedigree

status

alive or dead status

affected

affected or unaffected column

cex

spacing

col

column number, either 1 or the number of individuals

symbolsize

symbol size

branch

branch size

packed

boolean to pack the pedigree plot

align

align parameters

width

width parameter

density

density parameters

main_title

title on plot

mar

legend margins

angle

angle of labels

keep.par

boolean to keep or discard old graphics parameters

subregion

boolean whether or not to split plot into subregions

pconnect

controls parent connections


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