new templates

R/cohorts.R

@@ -1804,8 +1804,7 @@ pixelFate <- function(pixelFateDT, fate = NA_character_, pixelsRemoved = 0,
 #'
 #' @param x A \code{cohortData} object
 #'
-#' @param vegLeadingProportion Numeric between 0-1, determining the relative biomass
-#'                             threshold a species needs to pass to be considered "leading".
+#' @template vegLeadingProportion
 #'
 #' @param mixedType An integer defining whether mixed stands are of any kind of species
 #'                  admixture (1), or only when deciduous mixed with conifer (2).

R/maps.R

@@ -129,7 +129,7 @@ prepInputsLCC <- function(year = 2010,
 #'
 #' @param speciesStack A \code{RasterStack} of species abundances.
 #'                     This must be one \code{RasterLayer} per species.
-#' @param vegLeadingProportion See \code{vegTypeMapGenerator}.
+#' @template vegLeadingProportion
 #' @param mixed Deprecated. See \code{mixedType} argument to \code{vegTypeMapGenerator}.
 #' @param ... Other arguments passed to \code{vegTypeMapGenerator}, i.e.,
 #'   \code{vegLeadingProportion}, \code{mixedType}, \code{sppEquiv},
@@ -157,8 +157,7 @@ makeVegTypeMap <- function(speciesStack, vegLeadingProportion, mixed, ...) {
 #'
 #' @template pixelGroupMap
 #'
-#' @param vegLeadingProportion Numeric between 0-1, determining the relative biomass
-#'               threshold a species needs to pass to be considered "leading".
+#' @template vegLeadingProportion
 #'
 #' @param mixedType An integer defining whether mixed stands are of any kind of species
 #'                  admixture (1), or only when deciduous mixed with conifer (2).

R/plotting.R

@@ -12,8 +12,7 @@ utils::globalVariables(c(
 #' @param vtm An optional vegetation type map (\code{RasterLayer}).
 #'            If not supplied, will be produced internally by \code{makeVegTypeMap}.
 #'
-#' @param vegLeadingProportion The minimum proportion cover required to consider
-#'                             a species to be the "leading" one. Default 0.8.
+#' @template vegLeadingProportion
 #'
 #' @template sppEquiv
 #'

R/prepInputObjects.R

@@ -7,9 +7,7 @@ utils::globalVariables(c(
 #'
 #' @param speciesLayers stack of species layers rasters
 #' @template species
-#' @param sppColorVect A named vector of colours to use for plotting.
-#'                     The names must conform with \code{names(speciesLayers)} and should also
-#'                     contain a colour for 'Mixed'.
+#' @template sppColorVect
 #'
 #' @return
 #' A \code{list} with the \code{speciesLayers} and \code{sppColorVect}

R/sppHarmonize.R

@@ -4,8 +4,8 @@
 #' may arise under different combinations of supplied objects to the three
 #' arguments. See manual for details.
 #'
-#' @param sppEquiv A data.table or NULL representing the sppEquiv table (see manual).
-#'   If NULL, then it will use the `LandR::sppEquivalencies_CA`
+#' @template sppEquiv
+#'
 #' @param sppNameVector A character vector of species to use. These species must all
 #'   be from one naming convention, i.e., from one column in the sppEquiv.
 #' @param sppEquivCol A character string normally provided from the P(sim)$sppEquivCol

man-roxygen/sppColorVect.R

@@ -0,0 +1,7 @@
+#' @param sppColorVect A named vector of colours to use for plotting.
+#'                     The names must conform with species name convention used
+#'                     (see LandR::sppEquivalencies_CA for possible naming
+#'                     conventions) and should also contain a colour for 'Mixed',
+#'                     when a mixed forest type is supported  (see vegLeadingProportion
+#'                     parameter in LandR::vegTypeGenerator for details on mixed
+#'                     fores types).

man-roxygen/vegLeadingProportion.R

@@ -0,0 +1,2 @@
+#' @param vegLeadingProportion Numeric between 0-1, determining the relative biomass
+#'               threshold a species needs to pass to be considered "leading".