R/cycle_hire_osm.R

In spData: Datasets for Spatial Analysis

#' @name cycle_hire_osm
#' @aliases cycle_hire_osm
#' @title Cycle hire points in London from OSM
#'
#' @description Dataset downloaded using the osmdata package
#' representing cycle hire points accross London.
#' 
#' @format 
#' \itemize{
#'     \item{osm_id: The OSM ID}
#'     \item{name: The name of the cycle point}
#'     \item{capacity: How many bikes it can take}
#'     \item{cyclestreets_id: The ID linked to cyclestreets' photomap}
#'     \item{description: Additional description of points}
#'     \item{geometry: sfc_POINT}
#' }
#' 
#' @seealso 
#' See the osmdata package: https://cran.r-project.org/package=osmdata
#' 
#' @source \url{https://www.openstreetmap.org}
#' @docType data
#' @keywords datasets sf
#' 
#' @examples 
#' if (requireNamespace("sf", quietly = TRUE)) {
#'   library(sf)
#'   data(cycle_hire_osm)
#'   # or
#'   cycle_hire_osm <- st_read(system.file("shapes/cycle_hire_osm.geojson", package="spData"))
#'   
#'   plot(cycle_hire_osm)
#' }
#' 
#' # Code used to download the data:
#' \dontrun{
#' library(osmdata)
#' library(dplyr)
#' library(sf)
#' q = add_osm_feature(opq = opq("London"), key = "network", value = "tfl_cycle_hire")
#' lnd_cycle_hire = osmdata_sf(q)
#' cycle_hire_osm = lnd_cycle_hire$osm_points
#' nrow(cycle_hire_osm)
#' plot(cycle_hire_osm)
#' cycle_hire_osm = dplyr::select(cycle_hire_osm, osm_id, name, capacity, 
#'                                cyclestreets_id, description) %>%
#'   mutate(capacity = as.numeric(capacity))
#' names(cycle_hire_osm)
#' nrow(cycle_hire_osm)
#' }
"cycle_hire_osm"