Skip to content

Commit

Permalink
further Rd cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelcaceres committed Jul 24, 2024
1 parent 61d66fb commit 6fcd7f7
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions R/add_forests.R
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

#' Add forests
#'
#' Creates and adds forest data to an \code{\link{sf}} object by reading from tree and shrub data tables
#' Creates and adds forest data to an \code{\link[sf]{sf}} object by reading from tree and shrub data tables
#'
#' @param x An object of class \code{\link{sf}} with a valid CRS definition, and a column called 'id'.
#' @param x An object of class \code{\link[sf]{sf}} with a valid CRS definition, and a column called 'id'.
#' @param tree_table A data frame with tree records in rows and attributes in columns. Tree records can correspond to individual trees or groups of trees with an associated density.
#' @param tree_mapping A named character vector to specify mappings of columns in \code{tree_table} into attributes of \code{treeData}. Accepted names (and the corresponding specifications for the columns in \code{tree_table}) are:
#' \itemize{
Expand Down
2 changes: 1 addition & 1 deletion R/dataset_documentation.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' Default management prescriptions by species, defined according current practices in Catalonia (NE Spain)
#'
#' A data frame with 27 species (or species groups) in rows and management parameters in columns (defined in \code{\link{defaultManagementArguments}})
#' A data frame with 27 species (or species groups) in rows and management parameters in columns (defined in \code{\link[medfate]{defaultManagementArguments}})
#'
#' @name defaultPrescriptionsBySpecies
#' @aliases defaultPrescriptionsBySpecies
Expand Down
6 changes: 3 additions & 3 deletions R/impute_forests.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@
#' for correction of basal area. In that case, if there are no trees larger than \code{minDBH} but structural map indicates positive values of basal area,
#' DBH values will be set to minDBH, and correction of basal area will be performed.
#'
#' Function \code{check_forest()} checks first that \code{\link{forest}} objects are defined in "wildland" locations. Then, it looks for missing
#' Function \code{check_forest()} 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. The function does not modify the data.
#'
#' @return Functions \code{impute_forests()} and \code{modify_forest_structure()} return a modified object of class \code{\link{sf}}.
#' @return Functions \code{impute_forests()} and \code{modify_forest_structure()} return a modified object of class \code{\link[sf]{sf}}.
#' Function \code{check_forests()} returns an invisible data frame with columns indicating missing forest data and missing values in tree or shrub parameters.
#'
#' @author Miquel De \enc{Cáceres}{Caceres} Ainsa, CREAF
Expand Down Expand Up @@ -222,7 +222,7 @@ impute_forests <-function(x, sf_fi, dem,


#' @rdname forest_parametrization
#' @param structure_map An object of class \code{\link{rast}} or \code{\link{vect}} with a forest structural variable map
#' @param structure_map An object of class \code{\link[terra]{SpatRaster}} or \code{\link[terra]{SpatVector}} with a forest structural variable map
#' @param variable Structural variable to correct. See options in details.
#' @param map_var Variable name or index containing structural variable in 'structure_map'. If missing the first column is taken.
#' @param minDBH Minimum diameter for stand metric calculation. If \code{minDBH > 0} then those stands with smaller trees will not be corrected
Expand Down
2 changes: 1 addition & 1 deletion R/update_landscape.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#' @param y The object resulting of a simulation previously carried on \code{x}
#' using \code{\link{spwb_spatial}}, \code{\link{growth_spatial}}, \code{\link{spwb_land}}, etc.
#'
#' @return An object of class \code{\link{sf}} with modified state variables.
#' @return An object of class \code{\link[sf]{sf}} with modified state variables.
#'
#' @author Miquel De \enc{Cáceres}{Caceres} Ainsa, CREAF.
#'
Expand Down
4 changes: 2 additions & 2 deletions man/add_forests.Rd

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

2 changes: 1 addition & 1 deletion man/defaultPrescriptionsBySpecies.Rd

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

6 changes: 3 additions & 3 deletions man/forest_parametrization.Rd

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

2 changes: 1 addition & 1 deletion man/update_landscape.Rd

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

0 comments on commit 6fcd7f7

Please sign in to comment.