This function plots one or more kinship matrices and a shared legend for the color key. Many options allow for fine control of individual or subpopulation labeling.
plotPopkin(x, titles = NULL, col = NULL, xMar = NULL, marPad = 0.2,
diagLine = FALSE, panelLetters = toupper(letters), panelLetterCex = 1.5,
ylab = "Individuals", ylabAdj = NA, ylabLine = 0, addLayout = TRUE,
nr = 1, legTitle = "Kinship", legMar = NULL, nPretty = 5,
showNames = FALSE, namesCex = 1, namesLine = NA, labs = NULL,
labsCex = 1, labsLas = 0, labsLine = 0, labsSkipLines = FALSE,
labsLwd = 1, labsCol = "black", labsDoTicks = FALSE,
labsDoText = TRUE, labsEven = FALSE, ...)A numeric kinship matrix or a list of matrices
Titles to add to each matrix panel (default is no titles)
Colors for heatmap
Margins for each panel (if a list) or for all panels (if a vector). Margins are in c(bottom,left,top,right) format that par('mar') expects. By default the existing margin values are used without change
Margin padding added to all panels (xMar above and legMar below). Default 0.2. Must be a scalar or a vector of length 4 to match par('mar').
If TRUE adds a line along the diagonal (default no line). May also be a vector of booleans to set per panel (lengths must agree)
Vector of strings for labeling panels (default A-Z). No labels are added when there is only one panel, or if `panelLetters=NULL`
Scaling factor of panel letters (default 1.5)
AXIS LABEL OPTIONS
The y-axis label (default "Individuals"). If length(ylab)==1, the label is placed in the outer margin (shared across panels); otherwise length(ylab) must equal the number of panels and each label is placed in the inner margin of the respective panel
The value of "adj" passed to mtext. If length(ylab)==1, only the first value is used, otherwise length(ylabAdj) must equal the number of panels
The value of "line" passed to mtext. If length(ylab)==1, only the first value is used, otherwise length(ylabLine) must equal the number of panels
LAYOUT OPTIONS
If TRUE (default) then layout is called internally with appropriate values for the required number of panels for each matrix, the desired number of rows (see nr below) plus the color key legend. Set to FALSE and call layout beforehand if a non-standard layout or additional panels (beyond those provided by plotPopkin) are desired.
Number of rows in layout, used only if addLayout=TRUE
LEGEND (COLOR KEY) OPTIONS
The name of the variable that the heatmap colors measure (default "Kinship")
Margin vector (in c(bottom,left,top,right) format that par('mar') expects) for the legend panel only. If not provided, the margins used in the last panel are preserved with the exception that the left margin is set to zero (plus the value of marPad, see above).
The desired number of ticks in the legend y-axis (input to pretty, see that for more details)
INDIVIDUAL LABEL OPTIONS
If TRUE, the column and row names are plotted in the heatmap
Scaling factor for the column and row names
Line where column and row names are placed
SUBPOPULATION LABEL OPTIONS
Subpopulation labels for individuals. Use a matrix of labels to show groupings at more than one level (for a hierarchy or otherwise). If input is a vector or a matrix, the same subpopulation labels are shown for every heatmap panel; the input must be a list of such vectors or matrices if the labels vary per panel
A vector of label scaling factors for each level of labs, or a list of such vectors if labels vary per panel
A vector of label orientations (in format that mtext expects) for each level of labs, or a list of such vectors if labels vary per panel
A vector of lines where labels are placed (in format that mtext expects) for each level of labs, or a list of such vectors if labels vary per panel
A vector of booleans that specify whether lines separating the subpopulations are drawn for each level of labs, or a list of such vectors if labels vary per panel
A vector of line widths for the lines that divide subpopulations (if labsSkipLines=FALSE) for each level of labs, or a list of such vectors if labels vary per panel
A vector of colors for the lines that divide subpopulations (if labsSkipLines=FALSE) for each level of labs, or a list of such vectors if labels vary per panel
A vector of booleans that specify whether ticks separating the subpopulations are drawn for each level of labs, or a list of such vectors if labels vary per panel
A vector of booleans that specify whether the subpopulation labels are shown for each level of labs, or a list of such vectors if labels vary per panel. Useful for including separating lines or ticks without text.
A vector of booleans that specify whether the subpopulations labels are drawn with equal spacing for each level of labs, or a list of such vectors if labels vary per panel. When TRUE, lines mapping the equally-spaced labels to the unequally-spaced subsections of the heatmap are also drawn
Additional options passed to image. These are shared across panels
plotPopkin plots the input kinship matrices as-is.
For best results, a standard kinship matrix (such as the output of popkin) should have its diagonal rescaled to contain inbreeding coefficients (inbrDiag does this) before plotPopkin is used.
This function permits the labeling of individuals (from row and column names when showNames=TRUE) and of subpopulations (passed through labs).
The difference is that the labels passed through labs are assumed to be shared by many individuals, and lines (or other optional visual aids) are added to demarcate these subgroups.
For flexibility, this function will work for non-symmetric and even non-square matrices, even though proper kinship matrices are both.
For non-symmetric inputs, differing rownames and colnames will display correctly (if showNames==TRUE).
However, numerous options implicitly assume symmetry.
For example, only the y-axis is labeled under the assumption that the x-axis is the same.
Also, the same subpopulation labels are reproduced on both axes (for clarity).
# NOT RUN {
## Construct toy data
X <- matrix(c(0,1,2,1,0,1,1,0,2), nrow=3, byrow=TRUE) # genotype matrix
subpops <- c(1,1,2) # subpopulation assignments for individuals
## NOTE: for BED-formatted input, use BEDMatrix!
## "file" is path to BED file (excluding .bed extension)
# library(BEDMatrix)
# X <- BEDMatrix(file) # load genotype matrix object
## estimate the kinship matrix "Phi" from the genotypes "X"!
Phi <- popkin(X, subpops) # calculate kinship from X and optional subpop labels
## simple plot of the kinship matrix, marking the subpopulations only
## note inbrDiag replaces the diagonal of Phi with inbreeding coefficients
## (see vignette for more elaborate examples)
plotPopkin( inbrDiag(Phi), labs=subpops )
# }
Run the code above in your browser using DataLab