get_system_regions grabs and tidies the system_regions feed for
a given city. Metadata for this dataset can be found at:
https://github.com/MobilityData/gbfs/blob/master/gbfs.md
get_system_regions(
city,
directory = NULL,
file = "system_regions.rds",
output = NULL
)A character string that can be matched to a gbfs feed. The recommended argument is a system ID supplied in the output of [get_gbfs_cities()], but will also attempt to match to the URL of an active .json feed or city name.
Optional. Path to a folder (or folder to be created) where the feed will be saved.
Optional. The name of the file to be saved (if output
is set to "save" or "both"), as a character string.
Must end in ".rds".
Optional. The type of output method. If left as default, this
argument is inferred from the directory argument. If
output = "save", the object will be saved as an .rds object at
# the given path. If output = "return", the output will be returned
as a dataframe object. Setting output = "both" will do both.
The output of this function depends on argument to output
and directory. Either a saved .rds object generated from the current
feed, a dataframe object, or both.
[get_gbfs()] for a wrapper to call each of the get_feed
functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
are released by a given city.
# we can grab the system regions feed for portland,
# oregon in one of several ways! first, supply the `city`
# argument as a URL, and save to file by leaving output
# set to it's default. usually, we would supply a character
# string (like "pdx", maybe,) for the `directory` argument
# instead of `tempdir`.
get_system_regions(city =
"https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_regions.json",
directory = tempdir())
# or, instead, just supply the name of
# the city as a string and return the output
# as a dataframe
get_system_regions(city = "biketown_pdx",
output = "return")
#> region_id name
#> 1 PDX PDX