R/metrics.R

In StatsIMUWr/slobeC: What the package does (short line)

# Metrics used in simulations
#' MSE
#'
#' @param true Ground truth
#' @param predicted Estimated value
#' @param X Optional data matrix
#'
#' @return numeric
#'
#' @export
#'

mse <- function(true, predicted, X = NULL) {
    mean((true - predicted)^2)
}


#' True positives count
#'
#' @inheritParams mse
#' @importFrom dplyr near
#' @return numeric
#'
#' @export
#'

tp <- function(true, predicted, X = NULL) {
    sum(!near(true, 0) & !near(predicted, 0))
}


#' False positives count
#'
#' @inheritParams mse
#' @importFrom dplyr near
#' @return numeric
#'
#' @export
#'

fp <- function(true, predicted, X = NULL) {
    sum(!near(predicted, 0) & near(true, 0))
}


#' Prediction error
#'
#' @inheritParams mse
#'
#' @return numeric
#'
#' @export
#'

pred_error <- function(true, predicted, X) {
    sum((X %*% predicted - X %*% true) ^ 2)/sum((X %*% true) ^ 2)
}