cross_reactive_subgroup: Determine if a subgroup of negatives is cross-reactive

View source: R/cross_reactivity.R

cross_reactive_subgroupR Documentation

Determine if a subgroup of negatives is cross-reactive

Description

This is a wrapper around proportion_difference().

Usage

cross_reactive_subgroup(
  true_calls_overall,
  false_calls_overall,
  true_calls_subgroup,
  false_calls_subgroup,
  digits = 0.1,
  interval = 0.95
)

Arguments

true_calls_overall

The number of true calls (true negatives) in all samples tested.

false_calls_overall

The number of false calls (false positives) in all samples tested.

true_calls_subgroup

The number of true calls (true negatives) in the subgroup of interest (e.g. HIV+).

false_calls_subgroup

The number of false calls (false positives) in the subgroup of interest (e.g. HIV+).

digits

The number of digits to round to. Defaults to 0.1.

interval

The confidence interval to calculate. Defaults to 0.95 for 95%.

Value

A list containing the estimated difference, the confidence interval, a boolean attribute indicating whether or not a difference was detected at the specified confidence (difference_detected), and various strings and formatted percents that can be used to convey the information.

Examples

cross_reactive_subgroup(
  true_calls_overall = 79,
  false_calls_overall = 1,
  true_calls_subgroup = 9,
  false_calls_subgroup = 1,
  digits = 0.1,
  interval = 0.95
)

bjoleary/dxr documentation built on Dec. 5, 2023, 8:33 p.m.