ggpedigree: ggpedigree.

Description Usage Arguments

Description

ggpedigree.

ggpedigree: Plot a pedigree

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
ggpedigree(pedigree, cohort = NULL, sex = NULL, family = NULL,
  id.labels = FALSE, remove.singletons = TRUE,
  colour.parent.lines = TRUE, print.cohort.labels = TRUE,
  plot.unk.cohort = TRUE, single.cohort.x.shuffle = TRUE,
  randomise.x = TRUE, return.plot.tables = FALSE,
  suppress.plot = FALSE, line.col.mother = "#E41A1C",
  line.col.father = "#377EB8", line.alpha = 0.3, point.size = 2,
  point.colour = "black", point.alpha = 1, gg.theme = NULL,
  xlab = "", ylab = "", bg.colour = "ivory", plot.margin = c(1.5,
  1.5, 1.5, 1.5), axis.text.colour = "darkgrey")

Arguments

pedigree

A data frame of id, dam and sire

cohort

Default NULL. An optional vector assigning a cohort to each id. If NULL then uses kindepth function in kinship2 to assign IDs to cohorts.

sex

Default NULL. An optional vector assigning a sex to each id

family

Default NULL. An optional vector assigning a family to each id (NOT WORKING YET)

id.labels

logical. Default FALSE. Print the IDs on the pedigree.

remove.singletons

logical. Default TRUE. Remove IDs with no offspring or parents assigned.

colour.parent.lines

logical. Default TRUE. Colours lines based on maternal and paternal links.

print.cohort.labels

logical. Default TRUE. Prints cohort ideas on left hand side of plot.

plot.unk.cohort

logical. Default TRUE. Show IDs of unknown cohort.

single.cohort.x.shuffle

logical. Default TRUE. Randomly assign left to right position of IDs.

randomise.x

logical. Default TRUE.

return.plot.tables

logical. Default FALSE. Returns an object with the line and point data used for the plot.

suppress.plot

logical. Default FALSE. Print plot or not.

line.col.mother

line colour for mother

line.col.father

line colour for father

line.alpha

line alpha for plot

point.size

point size

point.colour

point colour

point.alpha

point alpha

gg.theme

extra theme information for ggplot

xlab

x axis label

ylab

y axis label

bg.colour

background colour

plot.margin

plot margin dimensions

axis.text.colour

axis text colour


susjoh/ggpedigree documentation built on May 30, 2019, 8:43 p.m.