R/data.R

In TDLM: Systematic Comparison of Trip Distribution Laws and Models

#' Population and number of out- and in-commuters by US Kansas county in 2000
#'
#' A dataset containing the number of inhabitants, in-commuters, and 
#' out-commuters for 105 US Kansas counties in 2000.
#'
#' @format A `data.frame` with 105 rows and 4 columns:
#' \describe{
#'   \item{rownames}{County ID.}
#'   \item{Population}{Number of inhabitants.}
#'   \item{Out-commuters}{Number of out-commuters.}
#'   \item{In-commuters}{Number of in-commuters.}
#' }
#' @source <https://www2.census.gov/programs-surveys/decennial/tables/2000/county-to-county-worker-flow-files/>
"mass"

#' Great-circle distances between US Kansas counties
#'
#' A dataset containing the great-circle distance (in kilometers) between 105
#' US Kansas counties.
#'
#' @format A `matrix` with 105 rows and 105 columns. Each element of the
#' matrix represents the distance between two counties. County IDs are used as 
#' row names and column names.
#' @source <https://www.census.gov/geographies/mapping-files/time-series/geo/carto-boundary-file.html>
"distance"

#' Origin-Destination commuting matrix between US Kansas counties in 2000
#'
#' A dataset containing the number of commuters between 105 US Kansas counties
#' in 2000.
#'
#' @format A `matrix` with 105 rows and 105 columns. Each element of the
#' matrix represents the number of commuters between two counties. County IDs 
#' are used as row names and column names.
#' @source <https://www2.census.gov/programs-surveys/decennial/tables/2000/county-to-county-worker-flow-files/>
"od"

#' Spatial distribution of US Kansas counties in 2000
#'
#' A dataset containing the geometry of 105 US Kansas counties.
#'
#' @format
#' \describe{
#'   \item{ID}{County ID.}
#'   \item{Longitude}{Longitude coordinate of the centroid of the county.}
#'   \item{Latitude}{Latitude coordinate of the centroid of the county.}
#'   \item{Area}{Surface area of the county (in square kilometers).}
#'   \item{geometry}{Geometry of the county.}
#' }
#' @source <https://www.census.gov/geographies/mapping-files/time-series/geo/carto-boundary-file.html>
"county"

#' Geographical coordinates of US Kansas counties' centroids in 2000 
#' (Longitude/Latitude)
#'
#' A dataset containing the geographical coordinates of US Kansas counties' 
#' centroids in 2000 (Longitude/Latitude).
#'
#' @format
#' \describe{
#'   \item{Longitude}{Longitude coordinate of the centroid of the county.}
#'   \item{Latitude}{Latitude coordinate of the centroid of the county.}
#' }
#' @source <https://www.census.gov/geographies/mapping-files/time-series/geo/carto-boundary-file.html>
"coords"

#' Geographical coordinates of US Kansas counties' centroids in 2000 
#' (X/Y based on Web Mercator)
#'
#' A dataset containing the geographical coordinates of US Kansas counties' 
#' centroids in 2000 (X/Y based on Web Mercator).
#'
#' @format
#' \describe{
#'   \item{X}{X coordinate of the centroid of the county.}
#'   \item{Y}{Y coordinate of the centroid of the county.}
#' }
#' @source <https://www.census.gov/geographies/mapping-files/time-series/geo/carto-boundary-file.html>
"coords_xy"