Skip to content

Commit

Permalink
update documentation check
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelcaceres committed Sep 12, 2024
1 parent d70284e commit 89bab39
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions R/check_inputs.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,14 @@
#'
#' Function \code{check_land_cover()} checks that column \code{"land_cover_type"} does not contain missing values.
#'
#' Function \code{check_forest()} checks first that \code{\link[medfate]{forest}} objects are defined in "wildland" locations. Then, it looks for missing
#' Function \code{check_forests()} checks first that \code{\link[medfate]{forest}} objects are defined in "wildland" locations. Then, it looks for missing
#' data in tree or shrub attributes required for simulations. If \code{SpParams} is provided, the function also checks
#' whether species names are within the taxa represented in \code{SpParams}.
#'
#' @return Functions return a modified \code{\link[sf]{sf}} object if \code{missing_action} is either \code{"filter"} or \code{"default"}. Otherwise,
#' Function \code{check_soils()} checks first that "wildland" and "agriculture" locations have a defined soil object. Then it looks for missing data in required
#' soil physical parameters.
#'
#' @return All functions return a modified \code{\link[sf]{sf}} object if \code{missing_action} is either \code{"filter"} or \code{"default"}. Otherwise,
#' they return an invisible tibble with logical columns indicating where missing information is.
#'
#' @export
Expand Down
7 changes: 5 additions & 2 deletions man/check_inputs.Rd

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

0 comments on commit 89bab39

Please sign in to comment.