ForestBasic: ForestBasic
In arnhew99/Jasper: Jasper makes plots

ForestBasic

R Documentation

ForestBasic

Description

Plot the central graphic part of a forest plot. Optionally, the text representation of the value and CIs may be added to the right of the forest and an additional column, usually N, may be added to the left.

Arguments

`rawdata`	Data frame formatted appropriately
`LogScale`	X axis should be on the log scale (default: TRUE)
`ExponentiateDataOnPlot`	rawdata data frame contains data that should be exponentiated when plotted. For instance, the data frame contains log RR but we want to plot RR (default: FALSE)
`blanks`	List of blank rows (default: NULL)
`Hets`	List of details of any heterogeneity tests to plot (default: NULL)
`Trends`	List of details of any trend tests to plot (default: NULL)
`xNoEffect`	X axis value to draw a vertical line, usually indicating the "line of no-effect" (default: NULL)
`NoEffect.lty`	(default: solid)
`xaxmin`	Left of the forest drawing area, in user coordinates. NLabels column will hang left of this
`xaxmax`	Right of the forest drawing area, in user coordinates. ValueLabels column will hang right of this
`xaxis`	Allow this function to draw an X axis (default: TRUE)
`ymin`	Bottom of the forest, in user coordinates (default: 0)
`ymax`	Top of the forest, in user coordinates (default: par("usr")[4])
`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)
`Range`	Deprecated; use xlim instead (default: NULL)
`xlim`	Vector giving min and max value of X range to be plotted (default: NULL)
`xticks`	Vector of tick marks to put on the X axis (default: NULL)
`ticklabs`	Character vector of tick labels to use instead of computed numeric values (default: NULL)
`xticks.ticklength`	(default: 0.25)
`mainfont`	Font scaling applied to cex (default: 1)
`xlab`	X axis label
`xlab.adjust`	(default: 0)
`ValueLabels`	Add the values and confidence intervals, anchored to the right of the forest (default: TRUE)
`ValueLabelsHeader`	Heading to put above the ValueLabels column (default: Hazard ratio)
`ValueLabelsEffectSE`	(default: FALSE)
`ValueDigits`	(default: NULL)
`ValueDigitsSE`	(default: NULL)
`separator`	Separator character to use in the confidence intervals in the ValueLabels column (default: NULL)
`NLabel`	Add a column anchored to the left of the forest, usually containing N (default: FALSE)
`NLabelHeader`	Heading to put above the N column (default: N)
`boxsizeoverride`	Disable scaling of boxes by inverse of variance (default: FALSE)
`roundedSquares`	Plot squares with rounded corners (not advised) (default: FALSE)
`spacing`	Space (in user coordinates) between forest and ValueLabels (default: 0)
`verbose`	Print diagnostic information while plotting (default: TRUE)
`drawPoints`	(default: TRUE)
`AdAM.mode`	Experimental mode for use with XML data (default: FALSE)
`pointGroups`	(default: NULL)
`pointGroupsFactor`	(default: 0.9)
`lwd`	Line width (scaling) (default: 1)
`CISecond`	(default: NULL)