From 37a039d39809920fb2764ffedadce404b54b407b Mon Sep 17 00:00:00 2001 From: Kyle Barrett Date: Thu, 19 Sep 2024 19:08:50 -0400 Subject: [PATCH] Documentation and error message fix - Towards the end of PR #711 I changed which model was passed to `nm_data(filter = TRUE)`. While updating the NEWS I realized some parameter documentation and an error message were not consistent with this change. - Minor enough to include in this PR --- R/bootstrap-model.R | 4 ++-- man/setup_bootstrap_run.Rd | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/R/bootstrap-model.R b/R/bootstrap-model.R index 60e4cca2..da7fc6eb 100644 --- a/R/bootstrap-model.R +++ b/R/bootstrap-model.R @@ -86,7 +86,7 @@ new_bootstrap_run <- function( #' @param seed A numeric seed to set prior to resampling the data; use `NULL` to #' avoid setting a seed. #' @param data A dataset to resample from. Defaults to `NULL`, which will use -#' the _filtered_ output from `nm_data(.mod, filter = TRUE)`. If provided, +#' the _filtered_ output from `nm_data(.boot_run, filter = TRUE)`. If provided, #' must include the same column names as what's returned from `nm_data(.mod)`. #' @param .bbi_args Named list passed to `model_summary(orig_mod, .bbi_args)`, #' where `orig_mod` is the model `.boot_run` is based on. See @@ -212,7 +212,7 @@ setup_bootstrap_run <- function( cli::cli_abort( c( "!" = "The filtered dataset does not have the same number of records as the original model:", - "*" = "{.code nm_data(orig_mod, filter = TRUE)} returned {.val {nrec_f}} records", + "*" = "{.code nm_data(.boot_run, filter = TRUE)} returned {.val {nrec_f}} records", "*" = "{.code model_summary(orig_mod)} returned {.val {nrec}} records", "i" = "where {.code orig_mod <- read_model(get_based_on(.boot_run))}", "i" = "Try providing a starting dataset (e.g., {.code setup_bootstrap_run(.boot_run, data = nm_join(orig_mod))})" diff --git a/man/setup_bootstrap_run.Rd b/man/setup_bootstrap_run.Rd index 0537c591..63018466 100644 --- a/man/setup_bootstrap_run.Rd +++ b/man/setup_bootstrap_run.Rd @@ -25,7 +25,7 @@ setup_bootstrap_run( avoid setting a seed.} \item{data}{A dataset to resample from. Defaults to \code{NULL}, which will use -the \emph{filtered} output from \code{nm_data(.mod, filter = TRUE)}. If provided, +the \emph{filtered} output from \code{nm_data(.boot_run, filter = TRUE)}. If provided, must include the same column names as what's returned from \code{nm_data(.mod)}.} \item{.bbi_args}{Named list passed to \code{model_summary(orig_mod, .bbi_args)},