ntpp.data.frame: An S3 Method to Compute the Ratio of Total Tests to Positive...

View source: R/ntpp-methods.R

ntpp.data.frameR Documentation

An S3 Method to Compute the Ratio of Total Tests to Positive Results

Description

ntpp.data.frame computes the ratio of the total number of tests performed per positive test result and the anticipated proportion of the untested (those screened out of testing) who would actually test positive.

Usage

## S3 method for class 'data.frame'
ntpp(object, ...)

Arguments

object

a dataframe containing columns named sensitivity, specificity and prev.

...

optional arguments to ntpp methods.

Details

The anticipated number of tests required to detect a single positive nntp is given by

nntp = (SeP + (1 - Sp)(1 - P)) / SeP

where Se is sensitivity, P is positivity and Sp is specificity. The anticipated positive proportion among those screened out is given by

Puntested = ((1 - Se)P) / ((1 - Se)P + Sp (1 - P))

Value

ntpp.easy_tool returns a data frame containing the following columns:

sensitivity

the sensitivity (proportion)

specificity

the specificity (proportion)

prev

positive proportion of the test condition

ntpp

anticipated total tests required per positive result

prev_untested

anticipated positive proportion among the untested


sgutreuter/screenr documentation built on Nov. 20, 2022, 2:41 a.m.