Skip to content

Commit 7fd4094

Browse files
committed
Fix document() and check() warnings regarding [epiprocess::]epi_df
Workaround for epiprocess#493.
1 parent be15821 commit 7fd4094

File tree

9 files changed

+11
-11
lines changed

9 files changed

+11
-11
lines changed

R/arx_classifier.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Direct autoregressive classifier with covariates
22
#'
33
#' This is an autoregressive classification model for
4-
#' [epiprocess::epi_df] data. It does "direct" forecasting, meaning
4+
#' [epiprocess::epi_df][epiprocess::as_epi_df] data. It does "direct" forecasting, meaning
55
#' that it estimates a class at a particular target horizon.
66
#'
77
#' @inheritParams arx_forecaster

R/arx_forecaster.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Direct autoregressive forecaster with covariates
22
#'
33
#' This is an autoregressive forecasting model for
4-
#' [epiprocess::epi_df] data. It does "direct" forecasting, meaning
4+
#' [epiprocess::epi_df][epiprocess::as_epi_df] data. It does "direct" forecasting, meaning
55
#' that it estimates a model for a particular target horizon.
66
#'
77
#'

R/cdc_baseline_forecaster.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Predict the future with the most recent value
22
#'
33
#' This is a simple forecasting model for
4-
#' [epiprocess::epi_df] data. It uses the most recent observation as the
4+
#' [epiprocess::epi_df][epiprocess::as_epi_df] data. It uses the most recent observation as the
55
#' forecast for any future date, and produces intervals by shuffling the quantiles
66
#' of the residuals of such a "flatline" forecast and incrementing these
77
#' forward over all available training data.
@@ -12,7 +12,7 @@
1212
#' This forecaster is meant to produce exactly the CDC Baseline used for
1313
#' [COVID19ForecastHub](https://covid19forecasthub.org)
1414
#'
15-
#' @param epi_data An [`epiprocess::epi_df`]
15+
#' @param epi_data An [`epiprocess::epi_df`][epiprocess::as_epi_df]
1616
#' @param outcome A scalar character for the column name we wish to predict.
1717
#' @param args_list A list of additional arguments as created by the
1818
#' [cdc_baseline_args_list()] constructor function.

R/data.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959

6060
#' Subset of Statistics Canada median employment income for postsecondary graduates
6161
#'
62-
#' @format An [epiprocess::epi_df] with 10193 rows and 8 variables:
62+
#' @format An [epiprocess::epi_df][epiprocess::as_epi_df] with 10193 rows and 8 variables:
6363
#' \describe{
6464
#' \item{geo_value}{The province in Canada associated with each
6565
#' row of measurements.}

R/epi_recipe.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ is_epi_recipe <- function(x) {
245245
#' @details
246246
#' `add_epi_recipe` has the same behaviour as
247247
#' [workflows::add_recipe()] but sets a different
248-
#' default blueprint to automatically handle [epiprocess::epi_df] data.
248+
#' default blueprint to automatically handle [epiprocess::epi_df][epiprocess::as_epi_df] data.
249249
#'
250250
#' @param x A `workflow` or `epi_workflow`
251251
#'

R/epi_workflow.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ fit.epi_workflow <- function(object, data, ..., control = workflows::control_wor
119119
#' - Call [parsnip::predict.model_fit()] for you using the underlying fit
120120
#' parsnip model.
121121
#'
122-
#' - Ensure that the returned object is an [epiprocess::epi_df] where
122+
#' - Ensure that the returned object is an [epiprocess::epi_df][epiprocess::as_epi_df] where
123123
#' possible. Specifically, the output will have `time_value` and
124124
#' `geo_value` columns as well as the prediction.
125125
#'

R/flatline_forecaster.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Predict the future with today's value
22
#'
33
#' This is a simple forecasting model for
4-
#' [epiprocess::epi_df] data. It uses the most recent observation as the
4+
#' [epiprocess::epi_df][epiprocess::as_epi_df] data. It uses the most recent observation as the
55
#' forcast for any future date, and produces intervals based on the quantiles
66
#' of the residuals of such a "flatline" forecast over all available training
77
#' data.
@@ -13,7 +13,7 @@
1313
#' This forecaster is very similar to that used by the
1414
#' [COVID19ForecastHub](https://covid19forecasthub.org)
1515
#'
16-
#' @param epi_data An [epiprocess::epi_df]
16+
#' @param epi_data An [epiprocess::epi_df][epiprocess::as_epi_df]
1717
#' @param outcome A scalar character for the column name we wish to predict.
1818
#' @param args_list A list of dditional arguments as created by the
1919
#' [flatline_args_list()] constructor function.

R/get_test_data.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Get test data for prediction based on longest lag period
22
#'
33
#' Based on the longest lag period in the recipe,
4-
#' `get_test_data()` creates an [epi_df]
4+
#' `get_test_data()` creates an [epi_df][epiprocess::as_epi_df]
55
#' with columns `geo_value`, `time_value`
66
#' and other variables in the original dataset,
77
#' which will be used to create features necessary to produce forecasts.

man/get_test_data.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)