rhomis-R-package: Essential Processes for RHoMIS Data

#' HDDS 10 test
#'
#' A dataset used for testing dietary diversity calculations with 10 food groups
#'
#' @format A tibble
#'
#'
#' @source A sample rhomis dataset
"hdds_10_test"

#' HDDS 14 test
#'
#' A dataset used for testing dietary diversity calculations with 14 food groups
#'
#' @format A tibble
#'
#'
#' @source A sample rhomis dataset
"hdds_14_test"

#' PPI limits
#'
#' A dataset indicating which PPI thresholds
#' were used by each country
#'
#' @format A tibble
#'
#'
#' @source A sample rhomis dataset
"ppi_limits"

#' PPI Scorecard
#'
#' A dataset used to convert from PPI score
#' to PPI likelihood for each individual country
#'
#' @format A tibble
#'
#'
#' @source A sample rhomis dataset
"ppi_score_card"

#' Crop Yield Units
#'
#' Conversion factors for the most common
#' crop yield units in the RHoMIS dataset
#'
#' @format A tibble
#'
#'
#' @source NA
"crop_amount_to_kg"

#' Crop Price Units
#'
#' Conversion factors for the most common
#' crop price units in the RHoMIS dataset
#'
#' @format A tibble
#'
#'
#' @source NA
"crop_price_to_lcu_per_kg"

#' Proportion Conversions
#'
#' Conversion factors for the string proportions
#' used to calculate the amounts of products sold
#' and consumed
#'
#' @format A tibble
#'
#'
#' @source NA
"proportion_conversions"

#' Livestock Weights
#'
#' Conversion factors for the weights
#' of livestock when they are killed for meat
#'
#' @format A tibble
#'
#'
#' @source NA
"livestock_weight_kg"


#' Milk Amount Units
#'
#' Conversion factors for the amounts
#' of milk collected
#'
#' @format A tibble
#'
#'
#' @source NA
"milk_amount_to_l"

#' Milk Price Time Units
#'
#' Conversion factors for the price of
#' milk, can both be a time or a per
#' unit volume
#'
#' @format A tibble
#'
#'
#' @source NA
"milk_price_to_lcu_per_l"

#' Eggs Amount Units
#'
#' Conversion factors for the amount
#' of eggs collected over a particular unit of time
#'
#' @format A tibble
#'
#'
#' @source NA
"eggs_amount_to_pieces_per_year"

#' Eggs Price Time Units
#'
#' Conversion factors for income from egg production
#'
#' @format A tibble
#'
#'
#' @source NA
"eggs_price_to_lcu_per_year"

#' Honey Amount Units
#'
#' Conversion factors for volume of honey into
#' kilograms
#'
#' @format A tibble
#'
#'
#' @source NA
"honey_amount_to_l"


#' Land Area Units
#'
#' Conversion of land area into hectares
#'
#' @format A tibble
#'
#'
#' @source NA
"land_area_to_ha"


#' Modules
#'
#' A dataset describing different survey modules, and the functions which can be used to process them
#'
#' @format A tibble
#'
#'
#' @source NA
"modules"


#' Country Conversions to ISO
#'
#' A dataset which converts country names found in previous RHoMIS surveys
#' into two letter ISO country codes
#'
#'  @source NA
"country_to_iso2"


#' Crop Name
#'
#' A list of common crop names which can be found in
#' previous rhomis datasets
#'
#'  @source NA
"crop_name_to_std"


#' Livestock Name
#'
#'  A list of common names found in previous RHoMIS datasets
#'
#'  @source NA
"livestock_name_to_std"

#' Fertiliser Units
#'
#' A list of common fertiliser amount units from previous RHoMIS datasets
#'
#'  @source NA
"fertiliser_amount_to_kg"

#' Crop Calories
#'
#' A list of calorie conversions for common crops
#'
#' @source NA
"crop_calories"

#' Egg Calories
#'
#' A list of calorie conversion for eggs
#'
#' @source NA
"eggs_calories"

#' Honey Calories
#'
#' Conversion factor for calories from honey
#'
#' @source NA
"honey_calories"

#' Milk Calories
#'
#' Calorie conversion factors for milk
#'
#' @source NA
"milk_calories"

#' Meat Calories
#'
#' Calorie conversion factors for meat
#'
#' @source NA
"meat_calories"

#' Sample Raw Data Set
#'
#' A sample raw rhomis dataset
#'
#' @source NA
"sample_raw_data_set"

#' Livestock TLU Conversions
#'
#' A table to convert different
#' types of livestock into
#' tropical livestock units
#'
#' @source NA
"livestock_count_to_tlu"


#' Indicator List
#'
#' A list of the different
#' indicators calculated in this
#' package, along with the functions
#' used to calculate them
#'
#' @source NA
"indicator_list"

#' Indicator List
#'
#' A list of the different
#' indicators calculated in this
#' package, along with the functions
#' used to calculate them
#'
#' @source NA
"indicator_list"

#' Function List
#'
#' A list of the functions used to
#' calculate various RHoMIS indicators
#'
#' @source NA
"function_list"


#' FP amount Conversions
#'
#' Conversions of FP amounts
#' to KG
#'
#' @source NA
"fp_amount_to_kg"


#' FP Income per Year
#'
#' Conversions of FP incomes
#' to lcu per year
#'
#' @source NA
"fp_income_per_freq_to_lcu_per_year"

#' FP Products
#'
#' The NTFP products which
#' are contained within the
#' NTFP module
#'
#' @source NA
"fp_products"


#' Currency Conversions
#'
#' World Bank currency conversions
#'
#' @source World Bank
"currency_conversion"

#' ISO Country Codes
#'
#' Conversions for official names
#' country/region codes
#'
#' @source iso
"country_codes"