Skip to content

Commit 9767d90

Browse files
committed
docs: doc all the params
1 parent 4c9bdec commit 9767d90

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

R/forecaster.R

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,14 @@ perform_sanity_checks <- function(epi_data,
4545
#' epipredict is a little bit fragile about having enough data to train; we want
4646
#' to be able to return a null result rather than error out; this check say to
4747
#' return a null
48+
#' @param epi_data the input data
4849
#' @param buffer how many training data to insist on having (e.g. if `buffer=1`,
4950
#' this trains on one sample; the default is set so that `linear_reg` isn't
5051
#' rank deficient)
52+
#' @param ahead the effective ahead; may be infinite if there isn't enough data.
53+
#' @param args_input the input as supplied to `forecaster_pred`; lags is the
54+
#' important argument, which may or may not be defined, with the default
55+
#' coming from `arx_args_list`
5156
#' @export
5257
confirm_insufficient_data <- function(epi_data, ahead, args_input, buffer = 9) {
5358
if (!is.null(args_input$lags)) {

man/confirm_insufficient_data.Rd

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)