Document and export `assess_multimodels()`

NAMESPACE

@@ -1,5 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
+export()
+export(assess_multimodels)
 export(average_spc)
 export(bind_lcols_dts)
 export(create_vip_rects)
@@ -21,14 +23,11 @@ export(predict_from_spc)
 export(preprocess_spc)
 export(read_asd)
 export(read_asd_bin)
-export(read_opus_bin_univ)
-export(read_opus_univ)
 export(remove_outliers)
 export(resample_spc)
 export(select_ref_spc)
 export(slice_xvalues)
 export(split_df2l)
-export(summary_df)
 import(purrr)
 import(stats)
 importFrom(data.table,":=")
@@ -42,6 +41,8 @@ importFrom(e1071,kurtosis)
 importFrom(foreach,"%do%")
 importFrom(foreach,"%dopar%")
 importFrom(magrittr,"%>%")
+importFrom(purrr,imap)
+importFrom(purrr,modify_depth)
 importFrom(rlang,ensym)
 importFrom(rlang,quo_name)
 importFrom(rlang,set_names)

R/utils-stats.R

@@ -13,8 +13,8 @@
 #'
 #' @return Data frame with with summary statistics for measured values and
 #' performance metrics for the pairs of measured and predicted values.
-#' @export
 #' @importFrom purrr modify_depth imap
+#' @export
 assess_multimodels <- function(data,
                                ...,
                                .metrics = c("simplerspec", "yardstick"),

man/assess_multimodels.Rd

@@ -0,0 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils-stats.R
+\name{assess_multimodels}
+\alias{assess_multimodels}
+\title{Assess multiple pairs of measured and predicted values}
+\usage{
+assess_multimodels(data, ..., .metrics = c("simplerspec", "yardstick"),
+  .model_name = "model")
+}
+\arguments{
+\item{data}{Data frame with all measured (observed) and predicted variables.}
+
+\item{...}{Multiple arguments with observed (measured)-predicted pairs,
+specified with \code{dplyr::vars(o = <column_name>, p = <column_name>)}.
+Column names can strings or symbols. The arguments in `...` need to be named.}
+
+\item{.metrics}{Character vector with package used for metrics calculation.
+Default is \code{"simplerspec"}, which uses
+\code{simplerspec::evaluate_model()}.}
+
+\item{.model_name}{String with name for the new column that specifies the
+model or the outcome variable. Default is \code{"model"}.}
+}
+\value{
+Data frame with with summary statistics for measured values and
+performance metrics for the pairs of measured and predicted values.
+}
+\description{
+Return performance metrics for test set predictions and
+measured values, e.g. for different model outcome variables.
+}