Skip to contents

Create an interactive plot for exposure duration

Usage

plotly_exp_duration(
  outdata,
  color = NULL,
  display = c("n", "prop"),
  display_total = TRUE,
  plot_type_label = c("Histogram", "Stacked histogram", "Horizontal histogram"),
  plot_group_label = "Treatment group",
  plot_category_label = "Exposure duration",
  hover_summary_var = c("n", "median", "sd", "se", "median", "min", "max", "q1 to q3",
    "range"),
  width = 1000,
  height = 400
)

Arguments

outdata

An outdata object created from prepare_exp_duration(). extend_exp_duration() can also be applied.

color

Color for a histogram.

display

A character vector of display type. n or prop can be selected.

display_total

A logical value to display total.

plot_type_label

A character vector of histogram type. The first element is for the standard histogram. The second element is for the stacked histogram. The third element is for the horizontal histogram.

plot_group_label

A label for grouping.

plot_category_label

A label for category.

hover_summary_var

A character vector of statistics to be displayed on hover label of bar.

width

Width of the plot.

height

Height of the plot.

Value

Interactive plot for exposure duration.

Examples

# Only run this example in interactive R sessions
if (interactive()) {
  meta <- meta_sl_exposure_example()
  outdata <- meta |>
    prepare_exp_duration() |>
    extend_exp_duration(
      duration_category_list = list(c(1, NA), c(7, NA), c(28, NA), c(12*7, NA), c(24*7, NA)),
      duration_category_labels = c(">=1 day", ">=7 days", ">=28 days", ">=12 weeks", ">=24 weeks")
    )

  outdata |> plotly_exp_duration()
}