LinearPlotFromCSV: LinearPlotFromCSV

View source: R/LinearPlotFromCSV.r

LinearPlotFromCSVR Documentation

LinearPlotFromCSV

Description

Plot a full-page Jasper figure containing (potentially) multiple panels, applying formatting styles on a per-panel, per-group basis. The R/Jasper code that renders the figure is also generated.

Arguments

file

Path to input CSV file

type

One of the valid SetPage file types (default: GUI)

orient

Page orientation, LANDSCAPE or PORTRAIT (default: PORTRAIT)

perpage

Force a particular number of plots per page rather than detecting it automatically from the CSV file (default: NULL)

filestem

String to use as the filename, an appropriate extension is appended automatically

cex

Font scaling factor (multiplies the underlying panel "unit" font size) (default: 1)

titlespace

Proportion of the page to allocate to a title area at the top of the page (default: 0.1)

footerspace

Proportion of the page to allocate to a footer area at the bottom of the page (default: 0.1)

wls.lines

Calculate and add fitted weighted least square regression lines on a per-group basis (default: FALSE)

join.points

Add line segments between points on a per-group basis (default: FALSE)

XLogScale

(default: FALSE)

XExponentiate

(default: FALSE)

YLogScale

(default: FALSE)

YExponentiate

(default: FALSE)

YLogNeededForSE

If Estimate is supplied with LCI and UCI as rate (hazard, odds) ratios then take logs when estimating the standard errors for box size scaling (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)

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)

show.xticklabs

If FALSE then do not add any tick labels to the X axis ticks (default: TRUE)

show.yticklabs

If FALSE then do not add any tick labels to the Y axis ticks (default: TRUE)

xlabs

Vector of labels to use as the X axis labels (default: NULL)

ylabs

Vector of labels to use as the Y axis labels (default: NULL)

point.labels.top.column

Specify a column in the CSV file that gives the labels to add above the upper end of the confidence interval (default: NULL)

point.labels.bottom.column

Specify a column in the CSV file that gives the labels to add below the bottom end of the confidence interval (default: NULL)

point.labels.cex

Font size scaling applied to point labels (default: 1)

boxparm.stderr

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

boxsizeoverride

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

mar

Vector of margins, in order c(bottom, left, top, right) (default: c(7, 7, 3, 3))

mar.optimise

(default: FALSE)

mar.spacing.horiz.target

(default: 3)

mar.force.left

(default: NULL)

mar.force.right

(default: NULL)

additionalR

Path to an additional R script to be added to the generated R code and run as part of the plot (default: NULL)

Author(s)

Matt Arnold


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