R/data.R

In djmorris1989/iomodeltobalc: Input-Output Modelling of Tobacco and Alcohol Policy

#' Alcohol price elasticities
#'
#' A data frame containing the price elasticity of demand for five types of alcohol; beer, cider,
#' wine, spirits, and RTDs split by off and on trade sales. Elasticities are obtained from multiple sources.
#'
#' @format A data frame with 5 observations and 4 variables.
#' \describe{
#'     \item{On-Trade Meng14}{On-trade alcohol price elasticities from Meng et al. (2014)}
#'     \item{Off-Trade Meng14}{Off-trade alcohol price elasticities from Meng et al. (2014)}
#'     \item{On-Trade Collis10}{On-trade alcohol price elasticities from Collis et al. (2010)}
#'     \item{Off-Trade Collis10}{Off-trade alcohol price elasticities from Collis et al. (2010)}
#' }
"elasticities"

#' Artificial alcohol and tobacco consumption data
#'
#' A data frame containing artificial price, consumption, tax, and elasticity data for tobacco and five
#' types of alcohol, differentiated by on-trade and off-trade. A total of 11 products. These data are
#' for use with the example IO table also provided by the package to illustrate the IO modelling.
#'
#' @format A data frame with 11 observations and 5 variables.
#' \describe{
#'     \item{price}{The current price per unit of the product.}
#'     \item{tax}{The current tax/duty per unit.}
#'     \item{consumption}{Total expenditure on the product.}
#'     \item{elasticity}{The product price elasticity of demand.}
#'     \item{taxProp}{Tax as a proportion of price.}
#' }
"data_example_consumption"

#' Artificial alcohol and tobacco IO table.
#'
#' A data frame containing a flow table, household demand, household output/employee compensation, final demand, and total output
#' for the example three-sector IO table.
#'
#' @format A data frame with 3 observations and 7 variables.
#' \describe{
#'     \item{Sector A}{Demands of Sector A from the row sector.}
#'     \item{Sector B}{Demands of Sector B from the row sector.}
#'     \item{Sector C}{Demands of Sector C from the row sector.}
#'     \item{Household Demand}{The vector of household demand (a component of final demand).}
#'     \item{Final Demand}{The vector of final demands (all non-intermediate demand).}
#'     \item{Household Output}{The vector of employee compensation - the value added to total output by household labour supply.}
#'     \item{Total Output}{The vector of total output - value of raw materials, plus imports, returns to capital and labour, taxes.}
#' }
"data_example_iotable"


#' Alcohol Consumption Data for Scotland 2000-2015.
#'
#' A data frame containing alcohol consumption data for Scotland. Data was compiled by Monitoring and Evaluating Scotlands Alcohol Strategy
#' (MESAS) from Nielsen and CGA Strategy. Off-trade alcohol sales have been adjusted to account for the exclusion of discount retailers.
#'
#' @format A data frame with 128 observations and 11 variables.
#' \describe{
#'     \item{year}{Demands of Sector A from the row sector.}
#'     \item{product}{Total alcohol, and 7 types of alcohol; spirits, RTDs, fortifies wines, wine, cider, perry, and beer.}
#'     \item{litres.ontrade}{total volume of on-trade alcohol sales (1000 litres)}
#'     \item{litres.offtrade}{total volume of off-trade alcohol sales (1000 litres)}
#'     \item{units.pp.ontrade}{total volume of on-trade alcohol sales (units) per adult (aged 16+ years)}
#'     \item{units.pp.offtrade}{total volume of off-trade alcohol sales (units) per adult (aged 16+ years)}
#'     \item{price.ontrade}{average price per unit of alcohol sold through the on-trade.}
#'     \item{price.offtrade}{average price per unit of alcohol sold through the off-trade.}
#'     \item{population}{total adult population mid-year.}
#'     \item{consumption.ontrade}{total estimated on-trade consumption - units per person X price per unit X population.}
#'     \item{consumption.offtrade}{total estimated off-trade consumption - units per person X price per unit X population.}
#' }
"data_mesas_scotland"

#' Alcohol Consumption Data for England & Wales 2000-2015.
#'
#' A data frame containing alcohol consumption data for England and Wales. Data was compiled by Monitoring and Evaluating Scotlands Alcohol Strategy
#' (MESAS) from Nielsen and CGA Strategy. Off-trade alcohol sales have been adjusted to account for the exclusion of discount retailers.
#'
#' @format A data frame with 128 observations and 11 variables.
#' \describe{
#'     \item{year}{Demands of Sector A from the row sector.}
#'     \item{product}{Total alcohol, and 7 types of alcohol; spirits, RTDs, fortifies wines, wine, cider, perry, and beer.}
#'     \item{litres.ontrade}{total volume of on-trade alcohol sales (1000 litres)}
#'     \item{litres.offtrade}{total volume of off-trade alcohol sales (1000 litres)}
#'     \item{units.pp.ontrade}{total volume of on-trade alcohol sales (units) per adult (aged 16+ years)}
#'     \item{units.pp.offtrade}{total volume of off-trade alcohol sales (units) per adult (aged 16+ years)}
#'     \item{price.ontrade}{average price per unit of alcohol sold through the on-trade.}
#'     \item{price.offtrade}{average price per unit of alcohol sold through the off-trade.}
#'     \item{population}{total adult population mid-year.}
#'     \item{consumption.ontrade}{total estimated on-trade consumption - units per person X price per unit X population.}
#'     \item{consumption.offtrade}{total estimated off-trade consumption - units per person X price per unit X population.}
#' }
"data_mesas_englandwales"