export and document case_weights_allowed (#1046)

* export and document case_weights_allowed

* missing pkgdown entry

---------

Co-authored-by: ‘topepo’ <‘mxkuhn@gmail.com’>

Author: topepo

DESCRIPTION

@@ -76,4 +76,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3.9000
+RoxygenNote: 7.2.3

NAMESPACE

@@ -178,6 +178,7 @@ export(bag_tree)
 export(bart)
 export(bartMachine_interval_calc)
 export(boost_tree)
+export(case_weights_allowed)
 export(cforest_train)
 export(check_empty_ellipse)
 export(check_final_param)

R/case_weights.R

@@ -67,6 +67,17 @@ patch_formula_environment_with_case_weights <- function(formula,
 
 # ------------------------------------------------------------------------------
 
+#' Determine if case weights are used
+#'
+#' Not all modeling engines can incorporate case weights into their
+#' calculations. This function can determine whether they can be used.
+#'
+#' @param spec A parsnip model specification.
+#' @return A single logical.
+#' @examples
+#' case_weights_allowed(linear_reg())
+#' case_weights_allowed(linear_reg(engine = "keras"))
+#' @export
 case_weights_allowed <- function(spec) {
   mod_type <- class(spec)[1]
   mod_eng <- spec$engine

_pkgdown.yml

@@ -71,6 +71,7 @@ reference:
       - add_rowindex
       - augment.model_fit
       - case_weights
+      - case_weights_allowed
       - descriptors
       - extract-parsnip
       - fit.model_spec