a little more documentation

Author: topepo

R/boost_tree.R

@@ -83,6 +83,8 @@
 #' @importFrom purrr map_lgl
 #' @seealso [fit()], [set_engine()]
 #' @examples
+#' show_engines("boost_tree")
+#'
 #' boost_tree(mode = "classification", trees = 20)
 #' # Parameters can be represented by a placeholder:
 #' boost_tree(mode = "regression", mtry = varying())

R/decision_tree.R

@@ -62,6 +62,8 @@
 #' @importFrom purrr map_lgl
 #' @seealso [fit()]
 #' @examples
+#' show_engines("decision_tree")
+#'
 #' decision_tree(mode = "classification", tree_depth = 5)
 #' # Parameters can be represented by a placeholder:
 #' decision_tree(mode = "regression", cost_complexity = varying())

R/linear_reg.R

@@ -62,6 +62,8 @@
 #'
 #' @seealso [fit()], [set_engine()]
 #' @examples
+#' show_engines("linear_reg")
+#'
 #' linear_reg()
 #' # Parameters can be represented by a placeholder:
 #' linear_reg(penalty = varying())

R/logistic_reg.R

@@ -60,6 +60,8 @@
 #'
 #' @seealso [fit()]
 #' @examples
+#' show_engines("logistic_reg")
+#'
 #' logistic_reg()
 #' # Parameters can be represented by a placeholder:
 #' logistic_reg(penalty = varying())

R/mars.R

@@ -41,6 +41,8 @@
 #' @importFrom purrr map_lgl
 #' @seealso [fit()]
 #' @examples
+#' show_engines("mars")
+#'
 #' mars(mode = "regression", num_terms = 5)
 #' @export
 mars <-

R/mlp.R

@@ -56,6 +56,8 @@
 #' @importFrom purrr map_lgl
 #' @seealso [fit()]
 #' @examples
+#' show_engines("mlp")
+#'
 #' mlp(mode = "classification", penalty = 0.01)
 #' # Parameters can be represented by a placeholder:
 #' mlp(mode = "regression", hidden_units = varying())

R/multinom_reg.R

@@ -56,6 +56,8 @@
 #'
 #' @seealso [fit()]
 #' @examples
+#' show_engines("multinom_reg")
+#'
 #' multinom_reg()
 #' # Parameters can be represented by a placeholder:
 #' multinom_reg(penalty = varying())

R/nearest_neighbor.R

@@ -51,6 +51,8 @@
 #' @seealso [fit()]
 #'
 #' @examples
+#' show_engines("nearest_neighbor")
+#'
 #' nearest_neighbor(neighbors = 11)
 #'
 #' @export

R/rand_forest.R

@@ -56,6 +56,8 @@
 #' @importFrom purrr map_lgl
 #' @seealso [fit()]
 #' @examples
+#' show_engines("rand_forest")
+#'
 #' rand_forest(mode = "classification", trees = 2000)
 #' # Parameters can be represented by a placeholder:
 #' rand_forest(mode = "regression", mtry = varying())

R/surv_reg.R

@@ -45,6 +45,8 @@
 #' @references Jackson, C. (2016). `flexsurv`: A Platform for Parametric Survival
 #'  Modeling in R. _Journal of Statistical Software_, 70(8), 1 - 33.
 #' @examples
+#' show_engines("surv_reg")
+#'
 #' surv_reg()
 #' # Parameters can be represented by a placeholder:
 #' surv_reg(dist = varying())