documentation update

Author: topepo

NAMESPACE

@@ -4,16 +4,20 @@ S3method(fit,model_spec)
 S3method(print,linear_reg)
 S3method(print,logistic_reg)
 S3method(print,rand_forest)
+S3method(print,surv_reg)
 S3method(translate,default)
 S3method(translate,rand_forest)
+S3method(translate,surv_reg)
 S3method(update,linear_reg)
 S3method(update,logistic_reg)
 S3method(update,rand_forest)
+S3method(update,surv_reg)
 export(fit)
 export(fit_control)
 export(linear_reg)
 export(logistic_reg)
 export(rand_forest)
+export(surv_reg)
 export(translate)
 export(varying)
 import(rlang)
@@ -25,6 +29,7 @@ importFrom(recipes,all_predictors)
 importFrom(recipes,juice)
 importFrom(recipes,prep)
 importFrom(stats,as.formula)
+importFrom(stats,formula)
 importFrom(stats,model.frame)
 importFrom(stats,model.matrix)
 importFrom(stats,model.response)

R/form_recipe.R

@@ -1,7 +1,7 @@
 # Class for creating an appropriate formula for a model based on the roles
 # contained in the recipe. 
 
-# maybe use `formula` generic with `formula.model_spec` acting as the generic?
+#' @importFrom stats formula
 
 formula.model_spec <- function(x, recipe, ...) {
   rec_vars <- summary(recipe)

R/linear_reg.R

@@ -106,9 +106,9 @@ print.linear_reg <- function(x, ...) {
 #'  in lieu of recreating the object from scratch.
 #'
 #' @inheritParams linear_reg
-#' @param object A linear reression model specification.
+#' @param object A linear regression model specification.
 #' @param fresh A logical for whether the arguments should be
-#'  modifed in-place of or replaced wholesale.
+#'  modified in-place of or replaced wholesale.
 #' @return An updated model specification.
 #' @examples
 #' model <- linear_reg(regularization = 10, mixture = 0.1)

R/logistic_reg.R

@@ -106,9 +106,9 @@ print.logistic_reg <- function(x, ...) {
 #'  in lieu of recreating the object from scratch.
 #'
 #' @inheritParams logistic_reg
-#' @param object A logistic reression model specification.
+#' @param object A logistic regression model specification.
 #' @param fresh A logical for whether the arguments should be
-#'  modifed in-place of or replaced wholesale.
+#'  modified in-place of or replaced wholesale.
 #' @return An updated model specification.
 #' @examples
 #' model <- logistic_reg(regularization = 10, mixture = 0.1)

R/rand_forest.R

@@ -103,7 +103,7 @@ print.rand_forest <- function(x, ...) {
 #' @inheritParams rand_forest
 #' @param object A random forest model specification.
 #' @param fresh A logical for whether the arguments should be
-#'  modifed in-place of or replaced wholesale.
+#'  modified in-place of or replaced wholesale.
 #' @return An updated model specification.
 #' @examples
 #' model <- rand_forest(mtry = 10, min_n = 3)
@@ -123,7 +123,7 @@ update.rand_forest <-
 
     args <- list(mtry = mtry, trees = trees, min_n = min_n)
 
-    # TODO make these blocks into a function amd document well
+    # TODO make these blocks into a function and document well
     if (fresh) {
       object$args <- args
     } else {

_pkgdown.yml

@@ -2,15 +2,20 @@ template:
   params:
     bootswatch: united
 
+figures:
+  fig.width: 8
+  fig.height: 5.75
+
 reference:
   - title: Models
     contents:
-      - rand_forest
+      - linear_reg
       - logistic_reg   
+      - rand_forest
+      - surv_reg   
   - title: Infrastructure
     contents:
       - translate
-      - update
       - fit
       - fit_control
       - varying