LinearPlot: LinearPlot

View source: R/LinearPlot.R

LinearPlotR Documentation

LinearPlot

Description

Plot a ‘linear’ style plot, either in the current panel, meaning that the user must already have handled the setting up of a decent coordinate system; or the next available one, allowing Jasper to compute the underlying coordinate system.

Arguments

linelist

List of data frames, each of which should contain RFLevel, Estimate and StdErr columns. Each data frame defines a "group" of points, which will be plotted with a common style.

reglines

Matrix of line parameters with two columns and the same number of rows as line groups. First column gives intercepts, second gives slopes. (default: NULL)

extendLines

(default: FALSE)

joinPoints

Join points in the same group by a piecewise line underneath the boxes (default: FALSE)

YLogScale

Use a log scale on the Y axis (default: FALSE)

XLogScale

Use a log scale on the X axis (default: FALSE)

DataLogged

Deprecated; use ExponentiateDataOnPlot instead (default: NULL)

ExponentiateDataOnPlot

The contents of the data table should be exponentiated when plotted. For instance, if the data contains log RR but you want to plot RR (default: NULL)

LineLabels

Labels to add at the right of a group (default: NULL)

boxcols

Vector of box colours, one per group (default: NULL)

boxbordercol

Vector of box border colours, one per group (default: NULL)

linecols

Vector of line colours (if plotted), one per group (default: NULL)

linelwds

Vector of line widths (if plotted), one per group (default: NULL)

lineltys

Vector of line types (if plotted), one per group (default: NULL)

new.plot

Allow this function to handle setting up a plotting area, either using the values given for xlim etc. or detecting them from the data (default: FALSE)

xlim

Vector giving min and max value of X range to be plotted (default: NULL)

ylim

Vector giving min and max value of Y range to be plotted (default: NULL)

axes

Allow this function to draw axes automatically (default: TRUE)

xaxis

Allow this function to draw an X axis (default: TRUE)

xaxis.line

(default: 1)

xticks

Vector of tick marks to put on the X axis (default: NULL)

xticklabs

Vector of labels to use at tick marks instead of X axis position of mark (default: NULL)

xticklabs.cex

(default: 1)

xlab

X axis label (default: NULL)

xlab.line

(default: NULL)

yaxis

Allow this function to draw an Y axis (default: TRUE)

yaxis.line

(default: 1)

yticks

Vector of tick marks to put on the Y axis (default: NULL)

yticklabs

Vector of labels to use at tick marks instead of Y axis position of mark (default: NULL)

ylab

Y axis label (default: NULL)

ylab.line

(default: NULL)

yticklabs.cex

(default: 1)

mainfont

Font scaling applied to cex (default: 1)

PointLabelsTop

Name of column in line group that gives labels to put above points (default: NULL)

PointLabelsBottom

Name of column in line group that gives labels to put below points (default: NULL)

PointLabelsPosAdj

Adjust the position of the point labels. Vector of length 2 giving top and bottom adjustment (default: NULL)

PointLabelsCol

Font colour to use for the point labels (default: NULL)

PointLabelsCEX

Font scaling applied to the point labels, relative to the panel default (default: 1)

useArrows

(default: TRUE)

TruncateAtPlotLims

(default: TRUE)

boxparmx

Specify X length of "unit" box (default: NULL)

boxparmy

Specify Y length of "unit" box (default: NULL)

boxparm.stderr

Provide the value of the smallest stderr to be used with computing the boxparm, instead of detecting it automatically. (default: NULL)

boxsizeoverride

Disable scaling of boxes by inverse of variance (default: FALSE)

margins

Vector of margins to use if drawing a new plot, in format (bottom, left, top, right) (default: NULL)

CIs

Can be one of three types of value. TRUE/FALSE turns plotting of CIs on or off globally. A vector of TRUE/FALSE turns CIs on or off per group. A list of TRUE/FALSE vectors turns CIs on and off on a per-point basis (default: TRUE)

CILineCol

(default: NULL)

PointCIs

Deprecated; use CIs instead (default: NULL)

CIsOnTop

(default: FALSE)

rBox

Draw boxes with rounded corners (not advised) (default: FALSE)

Author(s)

Matt Arnold


arnhew99/Jasper documentation built on Nov. 19, 2022, 2:46 p.m.