rebuild docs

* yml frontmatter changes to reference
* add internal keywords

Author: dajmcdon

R/blueprint-epi_recipe-default.R

@@ -9,6 +9,7 @@
 #' @details The `bake_dependent_roles` are automatically set to `epi_df` defaults.
 #' @return A recipe blueprint.
 #'
+#' @keywords internal
 #' @export
 new_epi_recipe_blueprint <-
   function(intercept = FALSE, allow_novel_levels = FALSE, fresh = TRUE,

R/df_mat_mul.R

@@ -13,6 +13,7 @@
 #' @return A data.frame with the new columns at the right. Original
 #'   columns are removed.
 #' @export
+#' @keywords internal
 #'
 #' @examples
 #' df <- data.frame(matrix(1:200, ncol = 10))

R/epi_keys.R

@@ -3,8 +3,8 @@
 #' @param x a data.frame, tibble, or epi_df
 #'
 #' @return If an `epi_df`, this returns all "keys". Otherwise `NULL`
+#' @keywords internal
 #' @export
-#'
 epi_keys <- function(x) {
   UseMethod("epi_keys")
 }

R/epi_recipe.R

@@ -215,6 +215,7 @@ epi_form2args <- function(formula, data, ...) {
 #' @param x An object.
 #' @return `TRUE` if the object inherits from `epi_recipe`.
 #'
+#' @keywords internal
 #' @export
 is_epi_recipe <- function(x) {
   inherits(x, "epi_recipe")

R/epi_shift.R

@@ -10,6 +10,8 @@
 #' @param keys Data frame, vector, or `NULL`. Additional grouping vars.
 #' @param out_name Chr. The output list will use this as a prefix.
 #'
+#' @keywords internal
+#'
 #' @return a list of tibbles
 epi_shift <- function(x, shifts, time_value, keys = NULL, out_name = "x") {
   if (!is.data.frame(x)) x <- data.frame(x)

R/epi_workflow.R

@@ -57,6 +57,7 @@ epi_workflow <- function(preprocessor = NULL, spec = NULL, postprocessor = NULL)
 #' @param x An object.
 #' @return `TRUE` if the object inherits from `epi_workflow`.
 #'
+#' @keywords internal
 #' @export
 is_epi_workflow <- function(x) {
   inherits(x, "epi_workflow")

R/extract.R

@@ -8,6 +8,8 @@
 #' @return An object originally passed as an argument to a layer or step
 #' @export
 #'
+#' @keywords internal
+#'
 #' @examples
 #' f <- frosting() %>%
 #'   layer_predict() %>%

R/grab_names.R

@@ -12,6 +12,7 @@
 #'   be used to select a range of variables.
 #'
 #' @export
+#' @keywords internal
 #' @return a character vector
 #' @examples
 #' df <- data.frame(a = 1, b = 2, cc = rep(NA, 3))

R/utils_misc.R

@@ -8,6 +8,8 @@
 #' @param object A layer object passed to [slather()].
 #' @param newname A string of variable names if the object doesn't contain a
 #'   $name element
+#'
+#' @keywords internal
 check_pname <- function(res, preds, object, newname = NULL) {
   if (is.null(newname)) newname <- object$name
   new_preds_names <- colnames(preds)

_pkgdown.yml

@@ -2,3 +2,39 @@ url: https://cmu-delphi.github.io/epipredict/
 template:
   bootstrap: 5
 
+
+reference:
+  - title: Simple forecasters
+    desc: Complete forecasters that produce reasonable baselines
+    contents:
+    - contains("flatline")
+    - contains("arx")
+  - title: Custom panel data forecasting workflows
+    contents:
+    - epi_recipe
+    - epi_workflow
+    - add_epi_recipe
+    - predict.epi_workflow
+    - augment.epi_workflow
+  - title: Epi recipe preprocessing steps
+    contents:
+    - starts_with("step_")
+  - title: Forecast postprocessing
+    desc: Create a series of postprocessing operations
+    contents:
+    - contains("frosting")
+    - get_test_data
+  - title: Frosting layers
+    contents:
+    - contains("layer")
+    - contains("slather")
+  - title: Utilities for quantile distribution processing
+    contents:
+    - dist_quantiles
+    - extrapolate_quantiles
+    - nested_quantiles
+  - title: Included datasets
+    contents:
+    - case_death_rate_subset
+
+