ped.legend: Plot a legend for the pedigree

In SaraMonts/kinship2_modified: Pedigree Functions. Modification of kinship2 package

Description

Create a plot with the description of the symbols that appear in the pedigree.

Usage

## S3 method for class 'legend'
ped(x, ped_id, adopted = NULL, phen.labels = c("phen1", "phen2", "phen3", "phen4"), 
                       cex = 1, col = c(1, 1, 1, 1), symbolsize = 1, mar = c(4.1, 1, 4.1, 1), width = 10, 
                       height = 4, density = c(-1, -1, -1, -1), angle = c(45, 45, 45, 45))

Arguments

x	object of class pedigree or pedigreeList obtained from the pedigree function.
ped_id	identifier number of the pedigree.
adopted	vector that contains adoption information for every subject. Values can be: "in" (adopted inside the family), "out" (adopted outside the family) or NA (not adopted).
phen.labels	vector that contains the names of the four phenotypes as character strings.
cex	controls text size. Default=1.
col	color for each phenotype. Default=c(1, 1, 1, 1).
symbolsize	controls symbolsize. Default=1.
mar	margin parmeters, as in the par function
width	width of the legend plot. Default=10
height	height of the legend plot. Default=4
density	defines the density used in the symbols for every phenotype. Default=c(-1, -1, -1, -1).
angle	defines the angle used in the symbols for every phenotype. Default=c(45, 45, 45, 45).

Value

Creates a plot containing the legend of the indicated pedigree.

See Also

plot.pedigree

SaraMonts/kinship2_modified documentation built on Jan. 8, 2021, 9:20 p.m.