siardensityplot: SIAR's Custom Density Plot

Description Usage Arguments Author(s)

View source: R/siardensityplot.R

Description

generates a custom density plot of the a matrix of data, usually but not exclusively representing the posterior draws of esimated parameters. Based on hdr.boxplot in the hdr package.

Usage

1
2
3
4
5
siardensityplot(dat, probs = c(95, 75, 50),
    xlab = "Group", ylab= "Value", xticklabels = NULL, yticklabels = NULL,
    type = "boxes", clr = gray((9:1)/10), scl = 1,
    xspc = 0.5, prn = F, leg = FALSE, ct = "mode",ylims=NULL,
    lbound = -Inf, ubound = Inf, main="",...)

Arguments

dat

Data to be plotted as a matrix.

probs

Define the extent probability intervals for a given parameter.

xlab

Specifies the text to print on the x-axis.

ylab

Specifies the text to print on the y-axis.

xticklabels

Specifies the text to associate with each group defined as ticks on the x-axis.

yticklabels

Specifies the text to associate with each tickmark on the y-axis.

type

Determines the style of graph. type="boxes" draws boxplot style (default), type="lines" draws overlain lines increasing in thickness

clr

Determines the set of colours to use for the boxes. Default is greyscale.

scl

Specifies a proportional scaling factor to increase (scl > 1) or decrease (scl < 1) the default width of lines or boxes. Default = 1.

xspc

Sets the amount of blank space either side of the first and last (on the x-axis) graphic object.

prn

If prn=TRUE the values for the defined probability densities (probs) are returned to the command window. Default is prn=FALSE with no such output.

leg

Determines whether a legend is to be drawn (leg=TRUE) or not (default leg=FALSE). Note, currently only supported for type="lines".

ct

Plots the specified measure of central tendancy, taking one of: 'mode', 'mean', 'median'

ylims

Sets the y axis limits. By default this is inferred from the data

lbound

Sets a strict limit on the lower extent of the posterior distribution. E.g. useful for values that must be strictly positive.

ubound

Sets a strict limit on the upper extent of the posterior distribution. E.g. useful for proportions that must be strictly less than one.

main

A title for the figure.

...

Additional parameters to be passed to plot

.

Author(s)

Andrew Jackson


siar documentation built on May 30, 2017, 2:17 a.m.