optimalThreshold: summary-methods – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

optimalThreshold

summary-methods

An S4 method that summarizes the results of a trtSelOpthThresh or a diagOpthThresh object.

Description

An S4 method that summarizes the results of a trtSelOpthThresh or a diagOpthThresh object.

Usage

## S4 method for signature 'trtSelOptThresh'
summary(object, alpha = 0.05,
  method = "median")

## S4 method for signature 'diagOptThresh'
summary(object, alpha = 0.05,
  method = "median")

Arguments

`object`	a `trtSelOptThresh` S4 class object for which a summary is desired.
`alpha`	alpha parameter for the confidence level required.
`method`	which method to use: median, mean or mode (median is the default).

Details

This function presents the results stocked in a trtSelOpthThresh object, or in a diagOpthThresh object. For a trtSelOpthThresh object it prints:

The decision rule: is the reference treatment recommended for low values of the marker?
The median (default), mean, or mode risk of event occurrence in each treatment arm, and their credible interval.
Some summary statistics of the marker under study (min, max, quartiles and mean)
The optimal threshold estimate and its credible interval (percentile and highest posterior density).
The median (default), mean, or mode risk in each arm under the marker-based strategy.
The median (default), mean, or mode benefit estimate under each treatment arm.
The percentage of NA values returned during the optimal threshold estimation process.

For a diagOpthThresh object, it prints:

The decision rule: is the reference treatment recommended for low values of the marker?
The median (default), mean, or mode risk of event occurrence in each treatment arm, and their credible interval.
Some summary statistics of the marker under study (min, max, quartiles and mean)
The optimal threshold estimate and its credible interval (percentile and highest posterior density).
The median (default), mean, or mode risk in each arm under the marker-based strategy.
The median (default), mean, or mode benefit estimate under each treatment arm.
The percentage of NA values returned during the optimal threshold estimation process.

Value

This function returns an object of class 'summaryTrtSelOptThresh'.

This function returns an object of class 'summaryDiagOptThresh'.

References

Blangero, Y, Rabilloud, M, Ecochard, R, and Subtil, F. A Bayesian method to estimate the optimal threshold of a marker used to select patients' treatment. Statistical Methods in Medical Research. 2019.

Subtil, F, and Rabilloud. A Bayesian method to estimate the optimal threshold of a longitudinal biomarker. Biometrical Journal. 2010.