Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Details to performance_roc() #777

Merged
merged 11 commits into from
Dec 29, 2024
Prev Previous commit
Next Next commit
fix
strengejacke committed Nov 24, 2024
commit b9f037a74299ee3fefaf3b3f103123e6c0cba48c
9 changes: 0 additions & 9 deletions R/performance_roc.R
Original file line number Diff line number Diff line change
@@ -17,15 +17,6 @@
#' - `Sensitivity`: It is the True Positive Rate, which is the proportion of
#' correctly classified "condition 1" observations.
#'
#' It returns the area under the curve (AUC) as a percentage, which corresponds
#' to the probability that a randomly chosen observation of "condition 1" is correctly
#' classified by the model as having a higher probability of being "condition 1" than
#' a randomly chosen "condition 2" observation.
#'
#' Applying `as.data.frame()` to the output returns a data frame containing the following:
#' - `Sensitivity` (that actually corresponds to `1 - Specificity`): It is the False Positive Rate.
#' - `Sensitivity`: It is the True Positive Rate, which is the proportion of correctly classified "condition 1" observations.
#'
#' @param x A numeric vector, representing the outcome (0/1), or a model with
#' binomial outcome.
#' @param predictions If `x` is numeric, a numeric vector of same length