R/data.R

In n-fanton/ndr: Non-Domestic Rates - Scotland

#' Local authorities with UA and data zone codes
#'
#' A tibble containing a list of local authorities with names,
#' UA codes as assigned by assessors, and data zone codes.
#'
#' Includes Scotland with \code{UA = 999}.
#'
#' For data zone codes, see
#' \url{https://www.gov.scot/publications/small-area-statistics-reference-materials/}
#'
#' @format A tibble with 33 rows and 3 columns:
#' \describe{
#'   \item{council}{name of local authority}
#'   \item{ua}{UA code}
#'   \item{dz_code}{data zone code}
#'   \item{vjb}{valuation joint board}
#'   ...
#' }
"local_authorities"

#' Functions contained in the \code{ndr} package
#'
#' A tibble containing a list of functions in this package, and brief
#' brief descriptions
#'
#' @format A tibble with 14 rows and 2 columns:
#' \describe{
#'   \item{function_code}{code used to call function}
#'   \item{description}{description of function}
#'   ...
#' }
"functions"