wocp | R Documentation |
Calculate optimal cut-off points for complex survey data (Iparragirre et al., 2022). Some functions of the package OptimalCutpoints (Lopez-Raton et al, 2014) have been used and modified in order them to consider sampling weights.
wocp(
response.var,
phat.var,
weights.var = NULL,
tag.event = NULL,
tag.nonevent = NULL,
method = c("Youden", "MaxProdSpSe", "ROC01", "MaxEfficiency"),
data = NULL,
design = NULL
)
response.var |
A character string with the name of the column indicating the response variable in the data set or a vector (either numeric or character string) with information of the response variable for all the units. |
phat.var |
A character string with the name of the column indicating the estimated probabilities in the data set or a numeric vector containing estimated probabilities for all the units. |
weights.var |
A character string indicating the name of the column with sampling weights or
a numeric vector containing information of the sampling weights.
It could be |
tag.event |
A character string indicating the label used to indicate the event of interest in |
tag.nonevent |
A character string indicating the label used for non-event in |
method |
A character string indicating the method to be used to select the optimal cut-off point.
Choose one of the following methods (Lopez-Raton et al, 2014):
|
data |
A data frame which, at least, must incorporate information on the columns
|
design |
An object of class |
Let S
indicate a sample of n
observations of the vector of random variables (Y,\pmb X)
, and \forall i=1,\ldots,n,
y_i
indicate the i^{th}
observation of the response variable Y
,
and \pmb x_i
the observations of the vector covariates \pmb X
. Let w_i
indicate the sampling weight corresponding to the unit i
and \hat p_i
the estimated probability of event.
Let S_0
and S_1
be subsamples of S
, formed by the units without the event of interest (y_i=0
) and with the event of interest (y_i=1
), respectively.
Then, the optimal cut-off points are obtained as follows:
Youden
:
c_w^{\text{Youden}}=argmax_c\{\widehat{Se}_w(c) + \widehat{Sp}_w(c)-1\},
MaxProdSpSe
:
c_w^{\text{MaxProdSpSe}}=argmax_c\{\widehat{Se}_w(c) * \widehat{Sp}_w(c)\},
ROC01
:
c_w^{\text{ROC01}}=argmax_c\{(\widehat{Se}_w(c)-1)^2 + (\widehat{Sp}_w(c)-1)^2\},
MaxEfficiency
:
c_w^{\text{MaxEfficiency}}=argmax_c\{\hat p_{Y,w}\widehat{Se}_w(c) + (1-\hat p_{Y,w})\widehat{Sp}_w(c)\},
where, the sensitivity and specificity parameters for a given cut-off point c
are estimated as follows:
\widehat{Se}_w(c)=\dfrac{\sum_{i\in S_1}w_i\cdot I (\hat p_i\geq c)}{\sum_{i\in S_1}w_i}\:;\:\widehat{Sp}_w(c)=\dfrac{\sum_{i\in S_0}w_i\cdot I (\hat p_i<c)}{\sum_{i\in S_0}w_i},
and,
\hat p_{Y,w}=\dfrac{\sum_{i\in S} w_i\cdot I(y_i=1)}{\sum_{i\in S} w_i}.
See Iparragirre et al. (2022) and Lopez-Raton et al. (2014) for more information.
The output of this function is an object of class wocp
. This object is a list that contains information about the following 4 elements:
tags
: a list containing two elements with the following information:
tag.event
: a character string indicating the event of interest.
tag.nonevent
: a character string indicating the non-event.
basics
: a list containing information of the following 4 elements:
n.event
: number of units with the event of interest in the data set.
n.nonevent
: number of units without the event of interest in the data set.
hatN.event
: number of units with the event of interest represented in the population by all the event units in the data set, i.e., the sum of the sampling weights of the units with the event of interest in the data set.
hatN.nonevent
: a numeric value indicating the number of non-event units in the population represented by means of the non-event units in the data set, i.e., the sum of the sampling weights of the non-event units in the data set.
optimal.cutoff
: this object is a list of three elements containing the information described below:
method
: a character string indicating the method implemented to select the optimal cut-off point.
optimal
: a list containing information of the following four elements:
cutoff
: a numeric vector indicating the optimal cut-off point(s) that optimize(s) the selected criterion.
Sew
: a numeric vector indicating the estimated sensitivity parameter(s) corresponding to the optimal cut-off point(s) that optimize(s) the selected criterion.
Spw
: a numeric vector indicating the estimated specificity parameter(s) corresponding to the optimal cut-off point(s) that optimize(s) the selected criterion.
criterion
: a numeric value indicating the criterion value optimized by means of the selected optimal cut-off point(s).
all
: a list containing information on the following four elements:
cutoff
: a numeric vector indicating all the cut-off points considered.
Sew
: a numeric vector indicating the estimated sensitivity parameters corresponding to all the considered cut-off points.
Spw
: a numeric vector indicating the estimated sensitivity parameters corresponding to all the considered cut-off points.
criterion
: a numeric vector indicating the values of the selected criterion corresponding to all the considered cut-off points.
call
: an object saving the information about the way in which the function has been run.
Iparragirre, A., Barrio, I., Aramendi, J. and Arostegui, I. (2022). Estimation of cut-off points under complex-sampling design data. SORT-Statistics and Operations Research Transactions 46(1), 137–158.
Lopez-Raton, M., Rodriguez-Alvarez, M.X, Cadarso-Suarez, C. and Gude-Sampedro, F. (2014). OptimalCutpoints: An R Package for Selecting Optimal Cutpoints in Diagnostic Tests. Journal of Statistical Software 61(8), 1–36.
data(example_data_wroc)
myocp <- wocp(response.var = "y", phat.var = "phat", weights.var = "weights",
tag.event = 1, tag.nonevent = 0,
method = "Youden",
data = example_data_wroc)
# Or equivalently
myocp <- wocp(example_data_wroc$y, example_data_wroc$phat, example_data_wroc$weights,
tag.event = 1, tag.nonevent = 0, method = "Youden")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.