PPV_heatmap {BayesianReasoning}R Documentation

Plot PPV and NPV heatmaps

Description

Plot heatmaps showing the PPV for a given Sensitivity and a range of Prevalences and False Positive values or NPV values for a given Specificity and a range of Prevalences and True Positive values

Usage

PPV_heatmap(
  Min_Prevalence = 1,
  Max_Prevalence = 1000,
  Sensitivity = 95,
  Min_FP = 0,
  Max_FP = 10,
  overlay = "no",
  overlay_labels = "",
  overlay_position_FP = 1,
  overlay_position_FN = 1,
  overlay_prevalence_1 = 1,
  overlay_prevalence_2 = 100,
  uncertainty_prevalence = "high",
  label_title = "",
  label_subtitle = "",
  Language = "en",
  folder = "",
  PPV_NPV = "PPV",
  DEBUG = 0
)

Arguments

Min_Prevalence

x in the "x out of y" prevalence (y-axis): [1-Inf]

Max_Prevalence

y in the "x out of y" prevalence (y-axis): [1-Inf]

Sensitivity

Sensitivity of the test: [0-100]

Min_FP

Minimum False Positives ratio to show in plot (x-axis): [1-100]

Max_FP

Maximum False Positives ratio to show in plot (x-axis): [1-100]

overlay

Show overlay: [TRUE, FALSE]

overlay_labels

Labels for each point in the overlay. For example: c("80", "70", "60", "50", "40", "30", "20 y.o.")

overlay_position_FP

FP value (position in the x-axis) for each point in the overlay. For example: c(7, 8, 9, 12, 14, 14)

overlay_position_FN

FN value (position in the x-axis) for each point in the overlay. For example: c(7, 8, 9, 12, 14, 14)

overlay_prevalence_1

Prevalence value (position in the y-axis) for each point in the overlay. For example: c(1, 1, 1, 2, 1, 1)

overlay_prevalence_2

Prevalence value (position in the y-axis) for each point in the overlay. For example: c(26, 29, 44, 69, 227, 1667)

uncertainty_prevalence

How much certainty we have about the prevalence ["high"/"low"]

label_title

Title for the plot

label_subtitle

Subtitle for the plot

Language

Language for the plot labels: ["sp", "en"]

folder

Where to save the plot (the filename would be automatically created using the plot parameters)

PPV_NPV

Should show PPV or NPV [PPV/NPV]

DEBUG

Shows debug warnings [0/1]

Value

Shows a plot or, if given a folder argument, saves a .png version of the plot

Examples

PPV_heatmap(Min_Prevalence = 1, 
Max_Prevalence = 1000, 
Sensitivity = 100, 
Max_FP = 2, 
Language = "en")

[Package BayesianReasoning version 0.3.3 Index]