Skip to content

Commit

Permalink
doc: remove wrong statements about bootstrap (#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
xrobin committed Feb 14, 2024
1 parent f03d246 commit 80b259f
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 12 deletions.
2 changes: 0 additions & 2 deletions man/ci.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
\description{
This function computes the confidence interval (CI) of a ROC curve. The
\code{of} argument controls the type of CI that will be computed.
By default, the 95\% CI are computed with 2000 stratified bootstrap
replicates.
}
\usage{
ci(...)
Expand Down
10 changes: 4 additions & 6 deletions man/ci.auc.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@

\description{
This function computes the confidence interval (CI) of an area under
the curve (AUC). By default, the 95\% CI is computed with 2000
stratified bootstrap replicates.
the curve (AUC).
}

\usage{
Expand Down Expand Up @@ -89,10 +88,9 @@ progress=getOption("pROCProgress")$name, parallel=FALSE, ...)
or a formula (response~predictor) arguments, the \code{\link{roc}}
function is called to build the ROC curve first.
The default is to use
\dQuote{delong} method except for comparison of partial AUC and smoothed
curves, where \code{bootstrap} is used. Using \dQuote{delong} for
partial AUC and smoothed ROCs is not supported.
The default is to use the \dQuote{delong} method, except for comparison of
partial AUC and smoothed curves, where \code{bootstrap} is used. Using
\dQuote{delong} for partial AUC and smoothed ROCs is not supported.
With \code{method="bootstrap"}, the function calls \code{\link{auc}}
\code{boot.n} times. For more details about the bootstrap, see the Bootstrap section in
Expand Down
1 change: 0 additions & 1 deletion man/ci.coords.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
\description{
This function computes the confidence interval (CI) of the coordinates
of a ROC curves with the \code{\link{coords}} function.
By default, the 95\% CI are computed with 2000 stratified bootstrap replicates.
}

\usage{
Expand Down
1 change: 0 additions & 1 deletion man/ci.se.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
\description{
This function computes the confidence interval (CI) of the sensitivity
at the given specificity points.
By default, the 95\% CI are computed with 2000 stratified bootstrap replicates.
}

\usage{
Expand Down
1 change: 0 additions & 1 deletion man/ci.sp.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
\description{
This function computes the confidence interval (CI) of the specificity
at the given sensitivity points.
By default, the 95\% CI are computed with 2000 stratified bootstrap replicates.
}

\usage{
Expand Down
1 change: 0 additions & 1 deletion man/ci.thresholds.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
\description{
This function computes the confidence interval (CI) of the sensitivity
and specificity of the thresholds given in argument.
By default, the 95\% CI are computed with 2000 stratified bootstrap replicates.
}

\usage{
Expand Down

0 comments on commit 80b259f

Please sign in to comment.