R/load_data.R

In JGCRI/ambrosia: An R package for calculating and analyzing food demand that is responsive to changing incomes and prices

## Sample datasets for ambrosia

#' Sample dataset of training data for ambrosia
#'
#' Sample data used within examples for ambrosia
#'
#' @docType data
#' @format A data frame with sample data used within examples for ambrosia
#' @usage data(training_data)
#'
#'
#' @keywords dataset
#'
#' @references Created using the Process_Demand_Data.R script in the scripts folder
#'
#' @examples
#' data(training_data)
"training_data"

#' Sample dataset of processed data
#'
#' Data processed using create_dataset_for_parameter_fit()
#' @format A data frame with data processed using create_dataset_for_parameter_fit()
#' @docType data
#'
#' @usage data(processed_data_example)
"processed_data_example"
#'
#' Sample dataset of mc data
#'
#' Data created using an MCMC approach
#'
#' @docType data
#' @format A data frame with data created using an MCMC approach
#' @usage data(mc_data_example)
"mc_data_example"
#'
#'
#' Dataset used for original parameter estimation
#'
#' Data used for original parameters estimated (output in mc_example)
#'
#' @docType data
#' @format A data frame with data used for original params
#' @usage data(data_used_for_original_param)
#'
#'
#' @keywords dataset
#'
#' @references Data used for original parameters estimated (output in mc_example)
#'
#' @examples
#' data(data_used_for_original_param)
"data_used_for_original_param"