Skip to content

Commit

Permalink
fix prepInputs(..., useCache) doc
Browse files Browse the repository at this point in the history
  • Loading branch information
CeresBarros committed Feb 29, 2024
1 parent 014d1de commit 5837008
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
8 changes: 5 additions & 3 deletions R/prepInputs.R
Original file line number Diff line number Diff line change
Expand Up @@ -191,9 +191,11 @@ utils::globalVariables(c(
#' Defaults to `getOption("reproducible.useCache", 2L)` in `prepInputs`, and
#' `getOption("reproducible.useCache", FALSE)` if calling any of the inner
#' functions manually. For `prepInputs`, this mean it will use `Cache`
#' only up to 2 nested levels, which will generally including `postProcess` and
#' the first level of `*Input` functions, e.g., `cropInputs`, `projectInputs`,
#' `maskInputs`, but not `fixErrors`.
#' only up to 2 nested levels, which includes `preProcess`. `postProcess` and
#' its nested `*Input` functions (e.g., `cropInputs`, `projectInputs`,
#' `maskInputs`) are no longer internally cached, as `terra` processing speeds
#' mean internal caching is more time consuming. We recommend caching the full
#' `prepInputs` call instead (e.g. `prepInputs(...) |> Cache()`).
#'
#' @param .tempPath Optional temporary path for internal file intermediate steps.
#' Will be cleared on.exit from this function.
Expand Down
8 changes: 5 additions & 3 deletions man/CacheGeo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/prepInputs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5837008

Please sign in to comment.