dx_forest: Create table with odds ratios displayed graphically

Description Usage Arguments Examples

View source: R/dx_forest.R

Description

Generate a table of diagnostic measures

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
dx_forest(
  dx_obj,
  fraction = FALSE,
  breaks = NA,
  limits = NA,
  tick_label_size = 6.5,
  trans = c(NA, "log10"),
  return_grid = FALSE,
  filename = NA
)

Arguments

dx_obj

An object of class dx

fraction

Logical. Should the fraction for sensitivity and specificity be shown?

breaks

A numeric vector of breaks to include on axis ticks. If left empty, breaks will be determined using the min and max value from 95% CIs.

limits

Limits for axis ticks. Ticks will be generates using base::breaks. Ignored if breaks are passed.

tick_label_size

Font size for axis labels.

trans

Method to transform the odds ratio by. Currently, only log10 is supported.

return_grid

Should a grid object be returned? If FALSE, grid is drawn using grid.draw.

filename

File bane to create on disk. If left NA, no file will be created.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
dx_obj <- dx(
  data = dx_heart_failure,
  study_name = "Heart Attack Prediction",
  data_description = "Validation Data",
  true_varname = "truth",
  pred_varname = "predicted",
  outcome_label = "Heart Attack",
  threshold_range = c(.1, .2, .3),
  setthreshold = .3,
  grouping_variables = c("AgeGroup", "Sex", "AgeSex")
)
dx_forest(dx_obj)
dx_forest(dx_obj, trans = "log10")

overdodactyl/diagnosticSummary documentation built on Jan. 13, 2020, 11:54 a.m.