FormatLP: FormatLP
In arnhew99/Jasper: Jasper makes plots

FormatLP

R Documentation

FormatLP

Description

Format a data frame to be suitable for plotting with LinearPlot, by specifying which columns provide the X and Y coordinates, and various other styling options.

Arguments

`LPdata`	Data frame to be formatted ready to be plotted using LinearPlot
`GroupCol`	(default: NULL)
`RFLevelCol`	Name of column in LPdata to be used as the risk factor levels (X axis positions)
`EstimateCol`	Name of column in LPdata to be used as the estimate (Y axis positions)
`StdErrCol`	Name of column in Lpdata to be used as the standard error (Y axis standard errors)
`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: NULL)
`xaxis`	Allow this function to draw an X axis (default: NULL)
`yaxis`	Allow this function to draw an Y axis (default: NULL)
`xticks`	Vector of tick marks to put on the X axis (default: NULL)
`yticks`	Vector of tick marks to put on the Y axis (default: NULL)
`xaxis.all`	Extend the axis to cover the whole range of the current panel (default: NULL)
`xticklabs`	Vector of labels to use at tick marks instead of X axis position of mark (default: NULL)
`yticklabs`	Vector of labels to use at tick marks instead of Y axis position of mark (default: NULL)
`yaxis.all`	Extend the axis to cover the whole range of the current panel (default: NULL)
`xlab`	X axis label (default: NULL)
`xlab.line`	Margin line at which to write the X axis label (default: NULL)
`ylab`	Y axis label (default: NULL)
`ylab.line`	Margin line at which to write the Y axis label (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)
`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: NULL)
`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: NULL)