layoutClinData {clinDataReview}

Set layout for a clinical data plot.

Description

Set layout for a clinical data plot.

Usage

layoutClinData(
  xLab = NULL,
  yLab = NULL,
  title = NULL,
  caption = NULL,
  subtitle = NULL,
  includeLegend = FALSE,
  legendPosition = "right",
  facet = FALSE,
  nrow = 1L,
  ncol = 1L,
  width,
  height,
  watermark = NULL,
  ...
)

Arguments

xLab

String with label for xVar.

yLab

String with label for xVar.

title

String with title for the plot.

caption

String with caption.
The caption is included at the bottom right of the plot. Please note that this might overlap with vertical or rotated x-axis labels.

subtitle

String with subtitle.
The subtitle is included at the top left of the plot, below the title.

includeLegend

Logical, if TRUE (by default) a legend is available in the plot.

legendPosition

String with position of the legend, among: 'top'/'left'/'bottom'/'right', 'right' by default.

facet

Logical (FALSE by default), does the plot contains facets?

nrow

single-length integer specifying the number of facet rows in the plot. (default = 1) Overwritten if gg is specified.

ncol

single-length integer specifying the number of facet columns in the plot. (default = 1) Overwritten if gg is specified.

width

Numeric, width of the plot in pixels, 800 by default.

height

Numeric, height of the plot in pixels, 500 by default.

watermark

(optional) String with path to a file containing a watermark.

...

Any parameters for the layout function. This should contain at least the plot object.

Value

The updated plotly object

Author(s)

Laure Cougnaud