R/documentationDatasets.R

In miquelcaceres/IFNdyn: IFN forest dynamics and scenario analysis

#' IFN data included in the package
#'
#' The IFN data provided with the package includes the following data items
#'
#' \itemize{
#'  \item{\code{estratosIFN3} A named list by province with a data frame indicating the area (in hectares) covered by each stratum (by code) at the time of IFN3.
#'                     Used to know the surface represented by each plot included in the simulation and, from there,
#'                     scale volume and biomass.
#'  }
#'  \item{\code{plotDataIFN} A data frame with IFN plots in rows (55715) and the following columns:
#'                     'Province' (1 to 50), 'SWHC' (mm), 'Rad' (MJ/day), 'Temp' (degrees C), 'slope' (degrees), 'Managed' (boolean) and 'Estrato' (stratum code).
#'                     Climate data are means over the period 1981-2015. Plots included are A1 plots between IFN2-IFN3 or between IFN3-IFN4.
#'  }
#' }
#'
#' @name IFN3data
#' @aliases IFNdata estratosIFN3 plotDataIFN
#' @docType data
#' @author Miquel De Cáceres
#' @keywords data
#' @references Project reference.
NULL

#' Default management planning
#'
#' Default management planning for IFN simulations, including silvicultural prescription by species and annual demand by province and species.
#'
#' \itemize{
#'   \item{\code{defaultDemand} List with elements by province, where each element contains the annual cubic meters by species (or species group). Derived from 'Anuarios de estadística forestal' (https://www.mapa.gob.es/en/desarrollo-rural/estadisticas/forestal_anuarios_todos.aspx).
#'   Each data frame has the following columns:
#'    \itemize{
#'       \item{\code{Species}: Species codes, separated by commas, to which the demand applies.}
#'       \item{\code{Name}: Species name(s) or species groups to which the demand applies.}
#'       \item{\code{AnnualDemand}: Annual demand in cubic meters for the target province.}
#'     }
#'   }
#'   \item{\code{defaultDemandCAT} List with elements by province in Catalonia, where the data from \code{DefaultDemand} has been complemented with firewood extraction from 'Observatori Forestal de Català' (http://www.observatoriforestal.cat/).}
#'   \item{\code{defaultPrescription} Data frame with prescribed silvicultural parameters per species (or species group).
#'               See dataset structure in \code{\link{examplePrescriptionData}}.}
#'   \item{\code{defaultPrescriptionCAT} Data frame with prescribed silvicultural parameters per species (or species group) in Catalonia.
#'               See dataset structure in \code{\link{examplePrescriptionData}}.}
#' }
#'
#' @name defaultDemand
#' @aliases defaultDemand defaultDemandCAT defaultPrescription defaultPrescriptionCAT
#' @docType data
#' @author Miquel De Cáceres, José Ramón González Olabarria
#' @keywords data
#' @references Project reference.
#' @examples
#' #Load prescriptions
#' data(defaultPrescriptionCAT)
#' head(defaultPrescriptionCAT)
#'
#' #Load demands
#' data(defaultDemandCAT)
#'
#' #Show demand for Lleida province
#' head(defaultDemandCAT$Lleida)
NULL


#' Model parameters
#'
#' Tables of species-specific parameters for growth, survival, ingrowth and height submodels
#'
#' \itemize{
#'  \item{\code{defaultGrowthParams}}
#'  \item{\code{defaultHeightGrowthParams}}
#'  \item{\code{defaultSurvivalParams} }
#'  \item{\code{defaultIngrowthDBHParams}}
#'  \item{\code{defaultIngrowthNParams}}
#'  \item{\code{defaultIngrowthBParams}}
#'  \item{\code{defaultIngrowthDBHParams_disp}}
#'  \item{\code{defaultIngrowthNParams_disp}}
#'  \item{\code{defaultIngrowthBParams_disp}}
#'  \item{\code{defaultHeightParams}}
#' }
#'
#' @name defaultGrowthParams
#' @aliases defaultGrowthParams defaultHeightGrowthParams defaultSurvivalParams defaultIngrowthDBHParams defaultIngrowthNParams defaultIngrowthBParams defaultIngrowthDBHParams_disp defaultIngrowthNParams_disp defaultIngrowthBParams_disp defaultHeightParams
#' @docType data
#' @author Miquel De Cáceres
#' @keywords data
#' @references Project reference.
NULL

#' Example datasets
#'
#' Data sets given to illustrate input data structures.
#'
#' \itemize{
#'   \item{\code{exampleTreeData} Tree data corresponding to three forest plots. Data frame with 40 rows (tree records) and columns:
#'     \itemize{
#'         \item{\code{Provincia}: Province.}
#'         \item{\code{Estadillo}: Plot code within province.}
#'         \item{\code{ID}: Unique plot code within IFN.}
#'         \item{\code{Species}: Tree species code.}
#'         \item{\code{N}: Tree density (individuals per hectare) that the record represents.}
#'         \item{\code{DBH}: Tree diameter at breast height (cm).}
#'         \item{\code{H}: Tree height (m)}
#'     }
#'   }
#'   \item{\code{examplePrescriptionData} Data frame with three rows (one per plot in \code{exampleTreeData}) and the following columns:
#'     \itemize{
#'         \item{\code{type}: Either 'regular' or 'irregular'.}
#'         \item{\code{thinning}: Either 'above' (i.e. thinning from above), 'below' (i.e. thinning from below), 'intermediate' (i.e. according to the current diameter distribution)
#'               or a string specifying diameter breaks and percentages (see details).}
#'         \item{\code{thinningBA}: Threshold for basal area. Thinning will be applied if the basal area of the stand is larger than the speficied value.}
#'         \item{\code{thinningHB}: Threshold for Hart-Becking index (if thinningBA = NA). Thinning will be applied if the Hart-Becking index of the stand is smaller than the speficied threshold value.}
#'         \item{\code{thinningPerc}: Percentage of initial basal area to be cut.}
#'         \item{\code{finalMeanDBH}: For regular management, threshold of mean diameter (in cm) separating thinnings from final cuts.}
#'         \item{\code{finalPrec}: For regular management, string with percentages of basal area to be removed in each final cut ('40-60-100' means a three final cuts,
#'         where percentages of basal area to be removed each time is 40\%, 60\% and 100\%).}
#'         \item{\code{plantingSpecies}: Tree species code to be planted after the final cut.}
#'         \item{\code{plantingDBH}: Tree DBH to be planted after the final cut (in cm).}
#'         \item{\code{plantingHeight}: Tree height to be planted after the final cut (in m).}
#'         \item{\code{plantingDensity}: Tree density to be planted after the final cut (in ind·ha-1).}
#'         \item{\code{finalPreviousStage}: Previous stage in final cut (0 - means thinning interventions, 1 - means first final cut, 2 - means second final cut, and so on).}
#'    }
#'  }
#' }
#'
#' @name exampleTreeData
#' @aliases exampleTreeData examplePrescriptionData
#' @docType data
#' @author Miquel De Cáceres
#' @keywords data
#' @references Project reference.
NULL