legend.line: Add line width legend

In ConnorFWhite/AssFunc: What the package does (short line)

Description

a wrapper for the legend command to place the line sizes onto a transBub plot

Usage

legend.line(Trans, x = NULL, y = NULL, nline = 4, lims.l = NULL, linesize = c(1, 5), sqrt = FALSE, rounddig = 2, bg = "White")

Arguments

Trans	Transistion matrix full of count data
x	x coordinate of the plot
y	y coordinate of the plot
nline	number of lines to have in plot
lims.l	vector of length two representing the min and max counts
linesize	vector of length two representing min and max line sizes
sqrt	should the count data be square root transformed
rounddig	number of digits to round numbers to
bg	color of background

Author(s)

Connor F. White

See Also

legend.bub, transbub

Examples

##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (Trans, x = NULL, y = NULL, nline = 4, lims.l = NULL, 
    linesize = c(1, 5), sqrt = FALSE, rounddig = 2, bg = "White") 
{
    if (is.null(x) | is.null(y)) {
        coords <- par("usr")
        x <- coords[1]
        y <- coords[4]
    }
    counts <- totcount(Trans)
    bubCounts <- counts$TransCount
    if (is.null(lims.l)) {
        llab <- seq(min(bubCounts[bubCounts > 0]), max(bubCounts[bubCounts > 
            0]), length.out = nline)
    }
    else {
        llab <- seq(lims.l[1], lims.l[2], length.out = nline)
    }
    lsize <- scal(llab, scal = linesize, lims = lims.l, sqrt = sqrt)
    legend(x = x, y = y, legend = round(llab, digits = rounddig), 
        lty = c(1, 1, 1, 1), lwd = lsize, bg = bg)
  }

ConnorFWhite/AssFunc documentation built on May 20, 2019, 4:07 p.m.