plotSegregation: Pedigree plot for segregation analysis

Description Usage Arguments Examples

View source: R/plotSegregation.R

Description

Plots a pedigree showing the segregation of a variant.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
plotSegregation(
  x,
  affected = NULL,
  unknown = NULL,
  proband = NULL,
  carriers = NULL,
  noncarriers = NULL,
  cex = 1,
  margins = rep(1, 4),
  ...
)

Arguments

x

A pedtools::ped() object.

affected

The affected pedigree members.

unknown

Pedigree members with unknown affection status.

proband

The ID label of the proband. This person must also be in both carriers and affected.

carriers

A character vector (or coercible to such), containing the ID labels of pedigree members known to carry the variant in question.

noncarriers

A character vector (or coercible to such), containing the ID labels of pedigree members known not to carry the variant in question.

cex, margins

Arguments passed on to pedtools::plot.ped().

...

Optional plot parameters passed on to pedtools::plot.ped().

Examples

1
2
3
x = nuclearPed(2)
plotSegregation(x, affected = 3:4, unknown = 1:2, proband = 3,
                carriers = 3:4, margins = c(1,3,1,1))

segregatr documentation built on April 15, 2021, 9:11 a.m.