updated ic_tbl documentation, WIP #60

R/utils.R

@@ -38,7 +38,7 @@ get_epidist_param <- function(epidist,
   return(unname(params[idx]))
 }
 
-#' Helper function to create model comparison table
+#' Helper function to create a model comparison table
 #'
 #' @description This is a helper function for creating a model comparison
 #' `<data.frame>` primarily for use in the \pkg{superspreading} vignettes. It
@@ -47,7 +47,9 @@ get_epidist_param <- function(epidist,
 #' function to create information criteria tables.
 #'
 #' @param ... [dots] One or more model fit results from
-#' [fitdistrplus::fitdist()]
+#' [fitdistrplus::fitdist()].
+#' @param sort_by A `character` string specifying which information criterion
+#' to order the table by, either `"AIC"` (default) or `"BIC"`.
 #'
 #' @return A `<data.frame>`.
 #' @export
@@ -59,7 +61,12 @@ ic_tbl <- function(..., sort_by = c("AIC", "BIC")) {
   # input checking
   stopifnot(
     "Input objects must be <fitdist>" =
-      vapply(models, checkmate::test_class, FUN.VALUE = logical(1), classes = "fitdist")
+      vapply(
+        models,
+        checkmate::test_class,
+        FUN.VALUE = logical(1),
+        classes = "fitdist"
+      )
   )
 
   distribution <- vapply(models, "[[", FUN.VALUE = character(1), "distname")