R/get_dynamic_feeds.R

In gbfs: Interface with Live Bikeshare Data

#' Grab the free_bike_status feed.
#' 
#' Grab a dataframe giving the geographic location and other metadata of
#' bikeshare bikes not parked at bikeshare stations. Metadata for this dataset
#' can be found at: \url{https://github.com/NABSA/gbfs/blob/master/gbfs.md}
#' 
#' @inherit get_station_information params seealso 
#' 
#' @return The output of this function depends on the argument to \code{output}
#' and \code{directory}. Either a saved .rds object generated from the current 
#' station_information feed, a dataframe object, or both. If a saved feed of
#' the same type already exists at the filepath, the feed will be appended to
#' rather than overwritten.
#' 
#' @examples
#' # grab the free bike status feed for portland, oregon's bikeshare program 
#' \donttest{get_free_bike_status(city = 
#' "https://gbfs.biketownpdx.com/gbfs/en/free_bike_status.json",
#' output = "return")}
#'                      
#' @export
get_free_bike_status <- function(city, directory = NULL, file = "free_bike_status.rds", output = NULL) {

  get_gbfs_dataset_(city, directory, file, output, feed = "free_bike_status")
  
}

#' Grab the station_status feed.
#' 
#' Grab a dataframe giving the geographic location and other metadata of
#' bikeshare bikes parked at bikeshare stations. Metadata for this dataset
#' can be found at: \url{https://github.com/NABSA/gbfs/blob/master/gbfs.md}
#' 
#' @inherit get_station_information params seealso 
#' 
#' @inherit get_free_bike_status return
#' 
#' @examples
#' # we can grab the free bike status feed for portland, 
#' # oregon's bikeshare program in several ways! the most 
#' # straightforward way is just to supply the `city` argument
#' # as a string:
#' \donttest{get_station_status(city = "biketown_pdx")}
#' 
#' # the `city` argument can also be supplied as an
#' # actual URL to an active .json feed
#' \donttest{get_station_status(city = 
#' "https://gbfs.biketownpdx.com/gbfs/en/station_status.json")}

#'                      
#' @export
get_station_status <- function(city, directory = NULL, file = "station_status.rds", output = NULL) {

  get_gbfs_dataset_(city, directory, file, output, feed = "station_status")
  
}