Skip to contents

Incidence of two arms as mirrored horizontal bars.

Usage

tfl_fig_butterfly(
  adam = NULL,
  style = c("soc", "pt"),
  data = "ADAE",
  term = NULL,
  group = "TRT01A",
  pop = "SAFFL",
  where = NULL,
  tefl = "TRTEMFL",
  top = 20,
  min_pct = 0,
  legend = "bottom",
  palette = "treatment",
  key = "USUBJID",
  theme = "boxed",
  title = NULL,
  width = 8,
  height = 5,
  dpi = 300,
  units = "in",
  file = NULL,
  plot_id = "butterfly"
)

Arguments

adam

Optional ADaM data (tfl_read_adam()); values found in the data (groups, colours) are written literally into the code.

style

soc (system organ class) or pt (preferred term).

data

Dataset name.

term

AE term variable.

group

Treatment variable; its first value is the reference.

pop

Population flag (== "Y"); NULL for none.

where

Extra record condition as R code, e.g. 'AVISIT != "Retrieval"'; NULL for none.

tefl

Treatment-emergent flag (NULL for all records).

top, min_pct

Show at most top terms with incidence of at least min_pct percent in any arm.

legend

Legend preset (none, right, bottom, top, inside, ...).

palette

Palette preset of the group (rate_ci, dodged) or of the category (stacked, default response).

key

Subject key used to join ADSL.

theme

Theme preset.

title

Figure title.

width, height, dpi, units

Figure size.

file

Write the script to this file.

plot_id

Used in the output file name.

Value

A tfl_code object: the figure's 'ggplot2' script, a character vector of class tfl_code with its specification in attribute spec; printing it shows the script.