R/sdm_metric_set.R

In tidysdm: Species Distribution Models with Tidymodels

#' Metric set for SDM
#'
#' This function returns a [yardstick::metric_set] that includes [boyce_cont()],
#' [yardstick::roc_auc()] and [tss_max()], the most commonly used metrics for
#' SDM.
#'
#' @param ... additional metrics to be added to the
#' [`yardstick::metric_set`]. See the help to [yardstick::metric_set()] for
#' constraints on the type of metrics that can be mixed.
#' @returns a [`yardstick::metric_set`] object.
#' @examples
#' sdm_metric_set()
#' sdm_metric_set(accuracy)
#' @export

sdm_metric_set <- function(...) {
  metric_set(boyce_cont, roc_auc, tss_max, ...)
}