R/data.R

In aj-sykes92/soilc.ipcc: The IPCC (2019) Tier 2 Steady-State Method for Soil Carbon

#' @name soilc_params
#' @title Default parameters for the IPCC (2019) steady-state soil carbon model
#' @description This dataset contains the core globally validated model parameters for the
#' three-pool, steady-state soil carbon model presented in the IPCC (2019) refinement.
#' @format A named list containing core model parameters.
#' @source Ogle, Wakelin, Buendia, et al. (2019) 2019 Refinement to the 2006 IPCC Guidelines for
#' National Greenhouse Gas Inventories, Volume 4 (Agriculture, Forestry and Other Land Use), Chapter
#' 5 (Cropland). Available at: https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html.
"soilc_params"

#' @name crop_agrc
#' @title Default IPCC coefficients for above-ground crop residue calculations
#' @description Contains the IPCC empirical model coefficients to estimate above-ground
#' residue biomass from crop yield.
#' @format A named list containing core model parameters.
#' @source Ogle, Wakelin, Buendia, et al. (2019) 2019 Refinement to the 2006 IPCC Guidelines for
#' National Greenhouse Gas Inventories, Volume 4 (Agriculture, Forestry and Other Land Use), Chapter
#' 5 (Cropland). Available at: https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html.
"crop_agrc"

#' @name crop_bgrc
#' @title Default IPCC coefficients for below-ground crop residue calculations
#' @description Contains the IPCC empirical model coefficients to estimate below-ground
#' residue biomass from above-ground residues.
#' @format A named list containing core model parameters.
#' @source Ogle, Wakelin, Buendia, et al. (2019) 2019 Refinement to the 2006 IPCC Guidelines for
#' National Greenhouse Gas Inventories, Volume 4 (Agriculture, Forestry and Other Land Use), Chapter
#' 5 (Cropland). Available at: https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html.
"crop_bgrc"

#' @name crop_fractions
#' @title Default IPCC coefficients for crop nitrogen and lignin fractions.
#' @description Contains default IPCC estimates for the nitrogen and lignin fractions of different
#' crop types.
#' @format A named list containing core model parameters.
#' @source Ogle, Wakelin, Buendia, et al. (2019) 2019 Refinement to the 2006 IPCC Guidelines for
#' National Greenhouse Gas Inventories, Volume 4 (Agriculture, Forestry and Other Land Use), Chapter
#' 5 (Cropland). Available at: https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html.
"crop_fractions"

#' @name man_fractions
#' @title Default IPCC coefficients for manure nutrient fractions.
#' @description Contains default IPCC estimates for the C:N ratio, nitrogen and lignin fractions of
#' manures from different livestock types.
#' @format A named list containing core model parameters.
#' @source Ogle, Wakelin, Buendia, et al. (2019) 2019 Refinement to the 2006 IPCC Guidelines for
#' National Greenhouse Gas Inventories, Volume 4 (Agriculture, Forestry and Other Land Use), Chapter
#' 5 (Cropland). Available at: https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html.
"man_fractions"

#' @name toy_input
#' @title Toy input data for soil C modelling.
#' @description A small, random, fairly believable input dataframe which can be used to test and
#' demonstrate \code{process_climdata()},\code{run_model()} and any of the associated helper
#' functions.
#' @format A nested tibble.
#' \describe{
#'   \item{year}{The year of the simulation run, an integer}
#'   \item{climdata}{A list of nested 3 * 12 dataframes containing monthly observations of
#'   temperature (\code{temp}, degrees Celsius), precipitation (\code{precip}, mm), and potential
#'   evapotranspiration (\code{pet}, mm).}
#'   \item{c_input}{The carbon input to the soil, in tonnes per hectare.}
#'   \item{lignin_frac}{The lignin content of soil organic matter inputs, fractional.}
#'   \item{n_frac}{The nitrogen content of soil organic matter inputs, fractional.}
#'   \item{sand_frac}{The sand content of the soil mineral makeup, fractional.}
#'   \item{till_type}{The tillage practice in use, a character variable, one of "full", "reduced",
#'   "zero" or "unknown".}
#' }
#' @source The author's imagination.
"toy_input"