get_what.simple_screenr: An S3 Method for Extraction of Components from...

In sgutreuter/screenr: Construction of Binary Test-Screening Rules

An S3 Method for Extraction of Components from simple_screenr Objects

Description

get_what.simple_screenr extracts components from simple_screenr-class objects.

Usage

## S3 method for class 'simple_screenr'
get_what(
  from = NULL,
  what = c("ROCci", "isROC"),
  ...,
  conf_level = 0.95,
  bootreps = 4000,
  se_min = 0.6
)

Arguments

from	the simple_screenr-class object from which to extract the component.
what	the (character) name of the component to extract. Valid values are ⁠"ROCci"⁠ and ⁠"isROC"⁠.
...	optional arguments to get_what methods.
conf_level	(optional) confidence level for what = ⁠"ROCci"⁠. Default: 09.5.
bootreps	the number of bootstrap replications for estimation of confidence intervals for what = ⁠"ROCci"⁠. Default: 4000.
se_min	minimum value of sensitivity printed for what = ⁠ROCci⁠. Default: 0.6.

Details

get_what is provided to enable easy extraction of components for those who wish to perform computations that are not provided by the plot, predict, print or summary methods.

The following values of what return:

⁠"isROC"⁠

the roc-class object produced by roc containing the in-sample (overly optimistic) receiver-operating characteristic.

⁠"ROCci"⁠

a data frame containing cross-validated sensitivities, specificities and their confidence limits, and thresholds.

Value

get_what.simple_screenr returns (invisibly) the object specified by what.

Examples

## Not run: 
data(unicorns)
too_simple <- simple_screenr(testresult ~ Q1 + Q2 + Q3 + Q4 + Q5 + Q6 + Q7,
                            data = unicorns)
too_simple_roc <- get_what(from = too_simple, what = "isROC" )
plot(too_simple_roc)

## End(Not run)

sgutreuter/screenr documentation built on Oct. 19, 2024, 12:49 p.m.