dx_lrt_pos: Calculate Positive Likelihood Ratio

View source: R/dx_metrics.R

dx_lrt_posR Documentation

Calculate Positive Likelihood Ratio

Description

Calculates the Positive Likelihood Ratio (LR+) from a confusion matrix object. LR+ compares the probability of a positive test result among patients with the disease to the probability of a positive test result among patients without the disease.

Usage

dx_lrt_pos(cm, detail = "full", ...)

Arguments

cm

A dx_cm object created by dx_cm().

detail

Character specifying the level of detail in the output: "simple" for raw estimate, "full" for detailed estimate including 95% confidence intervals.

...

Additional arguments to pass to metric_binomial function, such as citype for type of confidence interval method.

Details

The positive likelihood ratio is calculated as (TP / (TP + FN)) / (FP / (FP + TN)). It is used to assess the diagnostic usefulness of a test. A LR+ much greater than 1 indicates a good diagnostic test that can confidently confirm the disease when the test is positive.

Value

Depending on the detail parameter, returns a numeric value representing the calculated metric or a data frame/tibble with detailed diagnostics including confidence intervals and possibly other metrics relevant to understanding the metric.

Examples

cm <- dx_cm(dx_heart_failure$predicted, dx_heart_failure$truth,
  threshold =
    0.5, poslabel = 1
)
simple_lrp <- dx_lrt_pos(cm, detail = "simple")
detailed_lrp <- dx_lrt_pos(cm)
print(simple_lrp)
print(detailed_lrp)

overdodactyl/diagnosticSummary documentation built on Jan. 28, 2024, 10:07 a.m.