47 |
48 |
99 |
100 |
101 |
102 |
103 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
--------------------------------------------------------------------------------
/docs/bootstrap-toc.js:
--------------------------------------------------------------------------------
1 | /*!
2 | * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)
3 | * Copyright 2015 Aidan Feldman
4 | * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */
5 | (function() {
6 | 'use strict';
7 |
8 | window.Toc = {
9 | helpers: {
10 | // return all matching elements in the set, or their descendants
11 | findOrFilter: function($el, selector) {
12 | // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/
13 | // http://stackoverflow.com/a/12731439/358804
14 | var $descendants = $el.find(selector);
15 | return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])');
16 | },
17 |
18 | generateUniqueIdBase: function(el) {
19 | var text = $(el).text();
20 | var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');
21 | return anchor || el.tagName.toLowerCase();
22 | },
23 |
24 | generateUniqueId: function(el) {
25 | var anchorBase = this.generateUniqueIdBase(el);
26 | for (var i = 0; ; i++) {
27 | var anchor = anchorBase;
28 | if (i > 0) {
29 | // add suffix
30 | anchor += '-' + i;
31 | }
32 | // check if ID already exists
33 | if (!document.getElementById(anchor)) {
34 | return anchor;
35 | }
36 | }
37 | },
38 |
39 | generateAnchor: function(el) {
40 | if (el.id) {
41 | return el.id;
42 | } else {
43 | var anchor = this.generateUniqueId(el);
44 | el.id = anchor;
45 | return anchor;
46 | }
47 | },
48 |
49 | createNavList: function() {
50 | return $('');
51 | },
52 |
53 | createChildNavList: function($parent) {
54 | var $childList = this.createNavList();
55 | $parent.append($childList);
56 | return $childList;
57 | },
58 |
59 | generateNavEl: function(anchor, text) {
60 | var $a = $('');
61 | $a.attr('href', '#' + anchor);
62 | $a.text(text);
63 | var $li = $('
104 |
119 |
120 |
130 |
105 |
118 |
106 |
108 |
109 | Articles
107 |
110 |
117 | All vignettes
111 | 112 | 113 | 116 |`, then ``, etc.) that has more than one element. Defaults to 1 (for ``).
76 | getTopLevel: function($scope) {
77 | for (var i = 1; i <= 6; i++) {
78 | var $headings = this.findOrFilter($scope, 'h' + i);
79 | if ($headings.length > 1) {
80 | return i;
81 | }
82 | }
83 |
84 | return 1;
85 | },
86 |
87 | // returns the elements for the top level, and the next below it
88 | getHeadings: function($scope, topLevel) {
89 | var topSelector = 'h' + topLevel;
90 |
91 | var secondaryLevel = topLevel + 1;
92 | var secondarySelector = 'h' + secondaryLevel;
93 |
94 | return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
95 | },
96 |
97 | getNavLevel: function(el) {
98 | return parseInt(el.tagName.charAt(1), 10);
99 | },
100 |
101 | populateNav: function($topContext, topLevel, $headings) {
102 | var $context = $topContext;
103 | var $prevNav;
104 |
105 | var helpers = this;
106 | $headings.each(function(i, el) {
107 | var $newNav = helpers.generateNavItem(el);
108 | var navLevel = helpers.getNavLevel(el);
109 |
110 | // determine the proper $context
111 | if (navLevel === topLevel) {
112 | // use top level
113 | $context = $topContext;
114 | } else if ($prevNav && $context === $topContext) {
115 | // create a new level of the tree and switch to it
116 | $context = helpers.createChildNavList($prevNav);
117 | } // else use the current $context
118 |
119 | $context.append($newNav);
120 |
121 | $prevNav = $newNav;
122 | });
123 | },
124 |
125 | parseOps: function(arg) {
126 | var opts;
127 | if (arg.jquery) {
128 | opts = {
129 | $nav: arg
130 | };
131 | } else {
132 | opts = arg;
133 | }
134 | opts.$scope = opts.$scope || $(document.body);
135 | return opts;
136 | }
137 | },
138 |
139 | // accepts a jQuery object, or an options object
140 | init: function(opts) {
141 | opts = this.helpers.parseOps(opts);
142 |
143 | // ensure that the data attribute is in place for styling
144 | opts.$nav.attr('data-toggle', 'toc');
145 |
146 | var $topContext = this.helpers.createChildNavList(opts.$nav);
147 | var topLevel = this.helpers.getTopLevel(opts.$scope);
148 | var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
149 | this.helpers.populateNav($topContext, topLevel, $headings);
150 | }
151 | };
152 |
153 | $(function() {
154 | $('nav[data-toggle="toc"]').each(function(i, el) {
155 | var $nav = $(el);
156 | Toc.init($nav);
157 | });
158 | });
159 | })();
160 |
--------------------------------------------------------------------------------
/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 | Page not found (404) • gbfs
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
25 |
26 |
27 |
28 |
29 |
30 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 | Page not found (404)
75 |
76 |
77 | Content not found. Please use links in the navbar.
78 |
79 |
80 |
81 |
85 |
86 |
87 |
88 |
89 |
90 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
--------------------------------------------------------------------------------
/docs/authors.html:
--------------------------------------------------------------------------------
1 |
2 | Authors and Citation • gbfs
6 |
7 |
8 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
--------------------------------------------------------------------------------
/docs/reference/get_gbfs_cities.html:
--------------------------------------------------------------------------------
1 |
2 | Get table of all cities releasing GBFS feeds — get_gbfs_cities • gbfs
6 |
7 |
8 |
9 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Get table of all cities releasing GBFS feeds
47 | Source: R/get_gbfs.R
48 | get_gbfs_cities.Rd
49 |
50 |
51 |
52 | Get table of all cities releasing GBFS feeds
53 |
54 |
55 |
56 | get_gbfs_cities()
57 |
58 |
59 |
60 | Source
61 | North American Bikeshare Association, General Bikeshare Feed Specification
62 | https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv
63 |
64 |
65 | Value
66 | A data.frame of all cities issuing GBFS feeds. The `Auto-Discovery URL`
67 | column supplies the relevant .json feeds, while the entries in the `URL` column
68 | take the user to the public-facing webpage of the programs.
69 |
70 |
71 |
72 |
75 |
76 |
77 |
78 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
--------------------------------------------------------------------------------
/docs/CONTRIBUTING.html:
--------------------------------------------------------------------------------
1 |
2 | Contributor Code of Conduct • gbfs
6 |
7 |
8 |
9 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Contributor Code of Conduct
47 |
48 |
49 |
50 |
51 | As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
52 | We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
53 | Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
54 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct.
55 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
56 | This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html
57 |
58 |
59 |
60 |
61 |
64 |
65 |
66 |
67 |
68 |
69 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
--------------------------------------------------------------------------------
/R/get_gbfs.R:
--------------------------------------------------------------------------------
1 | #' Get table of all cities releasing GBFS feeds
2 | #'
3 | #' @return A \code{data.frame} of all cities issuing GBFS feeds. The `Auto-Discovery URL`
4 | #' column supplies the relevant .json feeds, while the entries in the `URL` column
5 | #' take the user to the public-facing webpage of the programs.
6 | #' @source North American Bikeshare Association, General Bikeshare Feed Specification
7 | #' \url{https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv}
8 | #' @export
9 | get_gbfs_cities <- function() {
10 |
11 | # test internet connection
12 | if (!connected_to_internet()) {
13 | return(message_no_internet())
14 | }
15 |
16 | # specify column types
17 | systems_cols <- readr::cols(
18 | `Country Code` = readr::col_character(),
19 | "Name" = readr::col_character(),
20 | "Location" = readr::col_character(),
21 | `System ID` = readr::col_character(),
22 | `URL` = readr::col_character(),
23 | `Auto-Discovery URL` = readr::col_character()
24 | )
25 |
26 | # grab the data
27 | readr::read_csv("https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv",
28 | col_types = systems_cols)
29 | }
30 |
31 |
32 |
33 | #' Get dataframe of bikeshare feeds released by a city
34 | #'
35 | #' @description Of the different types of feeds supplied by the gbfs,
36 | #' some are required, some are conditionally required, and some are
37 | #' optional. This function grabs a list of each of the feeds supplied
38 | #' by a given city, as well as the URLs to access them.
39 | #'
40 | #' @param city A character string that can be matched to a gbfs feed. The recommended
41 | #' argument is a system ID supplied in the output of [get_gbfs_cities()], but will
42 | #' also attempt to match to the URL of an active .json feed or city name.
43 | #'
44 | #' @return A \code{data.frame} containing the feeds supplied by
45 | #' a city. . The `feed` column supplies the name of the relevant .json feeds,
46 | #' while the entries in the `URL` column supply the feeds themselves.
47 | #'
48 | #' @source North American Bikeshare Association, General Bikeshare Feed
49 | #' Specification \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
50 | #'
51 | #' @examples
52 | #' # grab all of the feeds released by portland
53 | #' \donttest{get_which_gbfs_feeds(city = "biketown_pdx")}
54 | #'
55 | #' @export
56 | get_which_gbfs_feeds <- function(city) {
57 |
58 | # test internet connection
59 | if (!connected_to_internet()) {
60 | return(message_no_internet())
61 | }
62 |
63 | # convert the city argument to a URL
64 | url <- city_to_url(city, "gbfs")
65 |
66 | # grab the relevant data
67 | gbfs <- tryCatch(jsonlite::fromJSON(txt = url),
68 | error = report_connection_issue)
69 |
70 | # pull out the dataset
71 | gbfs_feeds <- gbfs[["data"]][[1]][[1]]
72 |
73 | # ...and return it!
74 | return(gbfs_feeds)
75 |
76 | }
77 |
78 | #' Grab bikeshare data
79 | #'
80 | #' \code{get_gbfs} grabs bikeshare data supplied in the General Bikeshare
81 | #' Feed Specification format for a given city. By default, the function returns
82 | #' the results as a named list of dataframes, but to make accumulation of
83 | #' datasets over time straightforward, the user can also save the results
84 | #' as .Rds files that will be automatically row-binded.
85 | #' Metadata for each dataset can be found at:
86 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
87 | #'
88 | #' @param city A character string that can be matched to a city or a url to an
89 | #' active gbfs.json feed. See \code{get_gbfs_cities} for a current list of available cities.
90 | #' @param feeds Optional. A character string specifying which feeds should be saved.
91 | #' Options are \code{"all"}, \code{"static"}, and \code{"dynamic"}.
92 | #' @param directory Optional. Path to a folder (or folder to be created) where
93 | #' the feed will will be saved.
94 | #' @param output Optional. The type of output method. By default, output method
95 | #' will be inferred from the \code{directory} argument. If \code{output = "save"},
96 | #' the dataframes will be saved as .rds objects in the given folder. If
97 | #' \code{output = "return"}, the results will be returned as a named list of
98 | #' dataframes. Setting \code{output = "both"} will do both. If both are left
99 | #' as NULL, the result will be returned and not saved to file.
100 | #' @return The output of this function depends on the arguments supplied to
101 | #' \code{output} and \code{directory}. Either a folder of .rds dataframes saved
102 | #' at the given path, a returned named list of dataframes, or both.
103 | #' The function will raise an error if the \code{directory} and \code{output}
104 | #' arguments seem to conflict.
105 | #' @examples
106 | #' # grab all of the feeds released by portland's
107 | #' # bikeshare program and return them as a
108 | #' # named list of dataframes
109 | #' \donttest{get_gbfs(city = "biketown_pdx")}
110 | #'
111 | #' # if, rather than returning the data, we wanted to save it:
112 | #' \donttest{get_gbfs(city = "biketown_pdx", directory = tempdir())}
113 | #'
114 | #' # note that, usually, we'd supply a character string
115 | #' # (like "pdx", maybe,) to the directory argument
116 | #' # instead of `tempdir()`.
117 | #'
118 | #' # if we're having trouble specifying the correct feed,
119 | #' # we can also supply the actual URL to the feed
120 | #' \donttest{get_gbfs(city = "https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json")}
121 | #'
122 | #' # the examples above grab every feed that portland releases.
123 | #' # if, instead, we just wanted the dynamic feeds
124 | #' \donttest{get_gbfs(city = "biketown_pdx", feeds = "dynamic")}
125 | #' @export
126 | get_gbfs <- function(city, feeds = "all", directory = NULL, output = NULL) {
127 |
128 | # test internet connection
129 | if (!connected_to_internet()) {
130 | return(message_no_internet())
131 | }
132 |
133 | # check the "feeds" argument
134 | feeds <- process_feeds_argument(feeds)
135 |
136 | # figure out how to output the resulting object
137 | output_types <- determine_output_types(directory, output)
138 |
139 | # check that, if the user said to save the file, they also
140 | # supplied a directory
141 | if (output_types[1] & is.null(directory)) {
142 | stop(sprintf(c("The argument to output suggests that the resulting",
143 | " data should be saved, but a directory to save the",
144 | " outputs in hasn't been supplied. Please supply",
145 | " an argument to directory or leave the output argument",
146 | " as default.")))
147 | }
148 |
149 | # convert the city argument to a top-level gbfs url
150 | url <- city_to_url(city, "gbfs")
151 |
152 | # figure out which feeds are available
153 | available_feeds <- get_which_gbfs_feeds(city = url)
154 |
155 | # ...and then figure out which of them to grab
156 | relevant_feeds <- available_feeds %>%
157 | dplyr::left_join(all_feeds, by = "name") %>%
158 | dplyr::filter(type %in% feeds) %>%
159 | dplyr::select(name) %>%
160 | dplyr::pull()
161 |
162 | # grab all of the relevant feeds! note that this will save each
163 | # of the datasets in the directory folder if directory is
164 | # something other than NULL
165 | data <- suppressMessages(
166 | purrr::map2(paste0(relevant_feeds, ".Rds"),
167 | relevant_feeds,
168 | get_gbfs_dataset_,
169 | city = url,
170 | directory = directory,
171 | output = NULL)
172 | )
173 |
174 | # name each of the elements so that they're more easily accessible
175 | names(data) <- relevant_feeds
176 |
177 | # output the datasets as desired :-)
178 | if (output_types[2]) {
179 | return(data)
180 | }
181 | }
182 |
183 |
--------------------------------------------------------------------------------
/README.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | output: github_document
3 | ---
4 |
5 | ```{r, echo = FALSE, message = FALSE}
6 | knitr::opts_chunk$set(
7 | collapse = TRUE,
8 | comment = "#>",
9 | fig.path = "figures/"
10 | )
11 | devtools::load_all()
12 | ```
13 |
14 | # General Bikeshare Feed Specification 
15 |
16 | [](https://cran.r-project.org/package=gbfs)
17 | [](https://github.com/simonpcouch/gbfs/actions)
18 | [](https://cran.r-project.org/package=gbfs)
19 |
20 | The `gbfs` package supplies a set of functions to interface with General
21 | Bikeshare Feed Specification .json feeds in R, allowing users to save
22 | and accumulate tidy .rds datasets for specified cities/bikeshare programs.
23 | The North American Bikeshare Association's [gbfs](https://github.com/MobilityData/gbfs)
24 | is a standardized data release format for live information on the status
25 | of bikeshare programs, as well as metadata, including counts of bikes at
26 | stations, ridership costs, and geographic locations of stations and
27 | parked bikes.
28 |
29 | __Features__
30 |
31 | * Get bikeshare data by specifying city name or supplying url of feed
32 | * All feeds for a city can be saved with a single function
33 | * New information from dynamic feeds can be appended to existing datasets
34 |
35 | ## Installation
36 |
37 | We're on CRAN! Install the latest release with:
38 |
39 | ```{r cran-installation, eval = FALSE}
40 | install.packages("gbfs")
41 | library(gbfs)
42 | ```
43 |
44 | You can install the developmental version of `gbfs` from GitHub with:
45 |
46 | ```{r gh-installation, eval = FALSE}
47 | # install.packages("devtools")
48 | devtools::install_github("simonpcouch/gbfs")
49 | ```
50 |
51 | ## Background
52 |
53 | The `gbfs` is a standardized data feed describing the current status of a
54 | bikeshare program.
55 |
56 | Although all of the data is live, only a few of the datasets change often:
57 |
58 | * `station_status`: Supplies the number of available bikes and
59 | docks at each station as well as station availability
60 | * `free_bike_status`: Gives the coordinates and metadata on available
61 | bikes that are parked, but not at a station.
62 |
63 | In this package, these two datasets are considered "dynamic", and can be
64 | specified as desired datasets by setting `feeds = "dynamic"` in the
65 | main wrapper function in the package, `get_gbfs`.
66 |
67 | Much of the data supplied in this specification can be considered static. If you
68 | want to grab all of these for a given city, set `feeds = "static"` when calling
69 | `get_gbfs`. Static feeds include:
70 |
71 | * `system_information`: Basic metadata about the bikeshare program
72 | * `station_information`: Information on the capacity and coordinates of stations
73 | * Several optional feeds: `system_hours`, `system_calendar`, `system_regions`,
74 | `system_pricing_plans`, and `system_alerts`
75 |
76 | Each of the above feeds can be queried with the `get_suffix` function, where
77 | `suffix` is replaced with the name of the relevant feed.
78 |
79 | For more details on the official `gbfs` spec, see
80 | [this document](https://github.com/MobilityData/gbfs/blob/master/gbfs.md).
81 |
82 | ## Example
83 |
84 | In this example, we'll grab data from Portland, Oregon's Biketown bikeshare
85 | program and visualize some of the different datasets.
86 |
87 | ```{r, warning = FALSE, message = FALSE}
88 | # load necessary packages
89 | library(tidyverse)
90 | ```
91 |
92 |
93 | First, we'll grab some information on the stations.
94 |
95 | ```{r}
96 | # grab portland station information and return it as a dataframe
97 | pdx_station_info <-
98 | get_station_information("https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json")
99 |
100 | # check it out!
101 | glimpse(pdx_station_info)
102 | ```
103 |
104 | ...as well as the number of bikes at each station.
105 |
106 | ```{r}
107 | # grab current capacity at each station and return it as a dataframe
108 | pdx_station_status <-
109 | get_station_status("https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json")
110 |
111 | # check it out!
112 | glimpse(pdx_station_status)
113 | ```
114 |
115 | Just like that, we have two tidy datasets containing information about
116 | Portland's bikeshare program.
117 |
118 | Joining these datasets, we can get the capacity at each station, along with each
119 | station's metadata.
120 |
121 | ```{r}
122 | # full join these two datasets on station_id and select a few columns
123 | pdx_stations <- full_join(pdx_station_info,
124 | pdx_station_status,
125 | by = "station_id") %>%
126 | # just select columns we're interested in visualizing
127 | select(id = station_id,
128 | lon,
129 | lat,
130 | num_bikes_available,
131 | num_docks_available) %>%
132 | mutate(type = "docked")
133 | ```
134 |
135 | Finally, before we plot, lets grab the locations of the bikes parked in
136 | Portland that are not docked at a station,
137 |
138 | ```{r}
139 | # grab data on free bike status and save it as a dataframe
140 | pdx_free_bikes <-
141 | get_free_bike_status("https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json",
142 | output = "return") %>%
143 | # just select columns we're interested in visualizing
144 | select(id = bike_id, lon, lat) %>%
145 | # make columns analogous to station_status for row binding
146 | mutate(num_bikes_available = 1,
147 | num_docks_available = NA,
148 | type = "free")
149 | ```
150 |
151 | ...and bind these dataframes together!
152 |
153 | ```{r}
154 | # row bind stationed and free bike info
155 | pdx_full <- bind_rows(pdx_stations, pdx_free_bikes)
156 | ```
157 |
158 | Now, plotting,
159 |
160 | ```{r plot}
161 | # filter out stations with 0 available bikes
162 | pdx_plot <- pdx_full %>%
163 | filter(num_bikes_available > 0) %>%
164 | # plot the geospatial distribution of bike counts
165 | ggplot() +
166 | aes(x = lon,
167 | y = lat,
168 | size = num_bikes_available,
169 | col = type) +
170 | geom_point() +
171 | # make aesthetics slightly more cozy
172 | theme_minimal() +
173 | scale_color_brewer(type = "qual")
174 | ```
175 |
176 | ```{r print-plot, eval = FALSE}
177 | pdx_plot
178 | ```
179 |
180 | 
181 |
182 | Folks who have spent a significant amount of time in Portland might be able to
183 | pick out the Willamette River running Northwest/Southeast through the city.
184 | With a few lines of `gbfs`, `dplyr`, and `ggplot2`, we can put together a
185 | meaningful visualization to help us better understand how bikeshare bikes
186 | are distributed throughout Portland.
187 |
188 | Some other features worth playing around with in `gbfs` that weren't touched
189 | on in this example:
190 |
191 | * The main wrapper function in the package, `get_gbfs`, will grab every
192 | dataset for a given city. (We call the functions to grab individual datasets
193 | above for clarity.)
194 | * In the above lines, we output the datasets as returned dataframes. If you'd
195 | rather save the output to your local files, check out the `directory` and
196 | `return` arguments.
197 | * When the `output` argument is left as default in `get_free_bike_status` and
198 | `get_station_status` (the functions for the `dynamic` dataframes,)
199 | and a dataframe already exists at the given path, `gbfs` will row bind the
200 | dataframes, allowing for the capability to accumulate large datasets over time.
201 | * If you're not sure if your city supplies `gbfs` feeds, you might find the
202 | `get_gbfs_cities` and `get_which_gbfs_feeds` functions useful.
203 |
204 | ## Contributing
205 |
206 | Please note that the `gbfs` R package is released with a [Contributor Code of Conduct](CONTRIBUTING.md). By contributing to this project, you agree to abide by its terms.
207 |
--------------------------------------------------------------------------------
/R/get_static_feeds.R:
--------------------------------------------------------------------------------
1 | #' Grab the station_information feed.
2 | #'
3 | #' \code{get_station_information} grabs and tidies the station_information feed for a given city.
4 | #' This dataset contains locations, capacity, and other information about bikeshare stations.
5 | #' Metadata for this dataset can be found at:
6 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
7 | #'
8 | #' @param city A character string that can be matched to a gbfs feed. The recommended
9 | #' argument is a system ID supplied in the output of [get_gbfs_cities()], but will
10 | #' also attempt to match to the URL of an active .json feed or city name.
11 | #' @param directory Optional. Path to a folder (or folder to be
12 | #' created) where the feed will be saved.
13 | #' @param file Optional. The name of the file to be saved (if \code{output}
14 | #' is set to \code{"save"} or \code{"both"}), as a character string.
15 | #' Must end in \code{".rds"}.
16 | #' @param output Optional. The type of output method. If left as default, this
17 | #' argument is inferred from the \code{directory} argument. If
18 | #' \code{output = "save"}, the object will be saved as an .rds object at
19 | #' # the given path. If \code{output = "return"}, the output will be returned
20 | #' as a dataframe object. Setting \code{output = "both"} will do both.
21 | #'
22 | #' @return The output of this function depends on argument to \code{output}
23 | #' and \code{directory}. Either a saved .rds object generated from the current
24 | #' feed, a dataframe object, or both.
25 | #'
26 | #' @seealso [get_gbfs()] for a wrapper to call each of the \code{get_feed}
27 | #' functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
28 | #' functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
29 | #' are released by a given city.
30 | #'
31 | #' @examples
32 | #' # grab the free bike status feed for portland, oreoon's bikeshare program
33 | #' \donttest{get_station_information(city =
34 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/station_information.json",
35 | #' output = "return")}
36 | #'
37 | #' @export
38 | get_station_information <- function(city, directory = NULL, file = "station_information.rds", output = NULL) {
39 |
40 | get_gbfs_dataset_(city, directory, file, output, feed = "station_information")
41 |
42 | }
43 |
44 | #' Grab the system_alerts feed.
45 | #'
46 | #' \code{get_system_alerts} grabs and tidies the system_alerts feed for a given city.
47 | #' This feed informs users about changes to normal operation. Metadata for this
48 | #' dataset can be found at: \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
49 | #'
50 | #' @inherit get_station_information params return seealso
51 | #'
52 | #' @examples
53 | #' # grab the system alerts feed for portland, oregon
54 | #' \donttest{get_system_alerts(city =
55 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_alerts.json",
56 | #' output = "return")}
57 | #'
58 | #' @export
59 |
60 | get_system_alerts <- function (city, directory = NULL, file = "system_alerts.rds", output = NULL) {
61 |
62 | get_gbfs_dataset_(city, directory, file, output, feed = "system_alerts")
63 |
64 | }
65 |
66 | #' Grab the system_calendar feed.
67 | #'
68 | #' \code{get_system_calendar} grabs and tidies the system_calendar feed
69 | #' for a given city. Metadata for this dataset can be found at:
70 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
71 | #'
72 | #' @inherit get_station_information params return seealso
73 | #'
74 | #' @examples
75 | #' # grab the system calendar feed for portland, oregon
76 | #' \donttest{get_system_calendar(city =
77 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_calendar.json",
78 | #' output = "return")}
79 | #'
80 | #'
81 | #' @export
82 |
83 | get_system_calendar <- function (city, directory = NULL, file = "system_calendar.rds", output = NULL) {
84 |
85 | get_gbfs_dataset_(city, directory, file, output, feed = "system_calendar")
86 |
87 | }
88 |
89 | #' Grab the system_hours feed.
90 | #'
91 | #' \code{get_system_hours} grabs and tidies the system_hours
92 | #' feed for a given city. Metadata for this
93 | #' dataset can be found at:
94 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
95 | #'
96 | #' @inherit get_station_information params return seealso
97 | #'
98 | #' @examples
99 | #' # grab the system hours feed for portland, oregon
100 | #' \donttest{get_system_hours(city =
101 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_hours.json",
102 | #' output = "return")}
103 | #'
104 | #' @export
105 |
106 | get_system_hours <- function (city, directory = NULL, file = "system_hours.rds", output = NULL) {
107 |
108 | get_gbfs_dataset_(city, directory, file, output, feed = "system_hours")
109 |
110 | }
111 |
112 | #' Grab the system_information feed.
113 | #'
114 | #' \code{get_system_information} grabs and tidies the system_information
115 | #' feed for a given city. Metadata for this dataset can be found at:
116 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
117 | #'
118 | #' @inherit get_station_information params return seealso
119 | #'
120 | #' @examples
121 | #' # we can grab the free bike status feed for portland,
122 | #' # oregon's bikeshare program in several ways! first, supply the `city`
123 | #' # argument as a URL, and save to file by leaving output
124 | #' # set to it's default. usually, we would supply a character
125 | #' # string (like "pdx", maybe,) for the `directory` argument
126 | #' # instead of `tempdir`.
127 | #' \donttest{get_system_information(city =
128 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_information.json",
129 | #' directory = tempdir())}
130 | #'
131 | #' # or, instead, just supply the name of
132 | #' # the city as a string and return the output as a dataframe
133 | #'\donttest{get_system_information(city = "biketown_pdx",
134 | #' output = "return")}
135 | #' @export
136 |
137 | get_system_information <- function(city, directory = NULL, file = "system_information.rds", output = NULL){
138 |
139 | get_gbfs_dataset_(city, directory, file, output, feed = "system_information")
140 |
141 | }
142 |
143 | #' Grab the system_pricing_plans feed.
144 | #'
145 | #' \code{get_system_pricing_plans} grabs and tidies the system_pricing_plans
146 | #' feed for a given city. Metadata for this dataset can be found at:
147 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
148 | #'
149 | #' @inherit get_station_information params return seealso
150 | #'
151 | #' @export
152 |
153 | get_system_pricing_plans <- function(city, directory = NULL, file = "system_pricing_plans.rds", output = NULL) {
154 |
155 | get_gbfs_dataset_(city, directory, file, output, feed = "system_pricing_plans")
156 |
157 | }
158 |
159 | #' Grab the system_regions feed.
160 | #'
161 | #' \code{get_system_regions} grabs and tidies the system_regions feed for
162 | #' a given city. Metadata for this dataset can be found at:
163 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
164 | #'
165 | #' @inherit get_station_information params return seealso
166 | #'
167 | #' @examples
168 | #' # we can grab the system regions feed for portland,
169 | #' # oregon in one of several ways! first, supply the `city`
170 | #' # argument as a URL, and save to file by leaving output
171 | #' # set to it's default. usually, we would supply a character
172 | #' # string (like "pdx", maybe,) for the `directory` argument
173 | #' # instead of `tempdir`.
174 | #' \donttest{get_system_regions(city =
175 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_regions.json",
176 | #' directory = tempdir())}
177 | #'
178 | #' # or, instead, just supply the name of
179 | #' # the city as a string and return the output
180 | #' # as a dataframe
181 | #'\donttest{get_system_regions(city = "biketown_pdx",
182 | #' output = "return")}
183 | #' @export
184 | get_system_regions <- function(city, directory = NULL, file = "system_regions.rds", output = NULL) {
185 |
186 | get_gbfs_dataset_(city, directory, file, output, feed = "system_regions")
187 |
188 | }
189 |
--------------------------------------------------------------------------------
/docs/reference/index.html:
--------------------------------------------------------------------------------
1 |
2 | Package index • gbfs
6 |
7 |
8 |
9 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Reference
47 |
48 |
49 |
50 | All functions
51 |
52 |
53 |
54 |
55 |
56 | Package: gbfs
58 |
59 |
60 | Grab the free_bike_status feed.
62 |
63 |
64 | Grab bikeshare data
66 |
67 |
68 | Get table of all cities releasing GBFS feeds
70 |
71 |
72 | Grab the station_information feed.
74 |
75 |
76 | Grab the station_status feed.
78 |
79 |
80 | Grab the system_alerts feed.
82 |
83 |
84 | Grab the system_calendar feed.
86 |
87 |
88 | Grab the system_hours feed.
90 |
91 |
92 | Grab the system_information feed.
94 |
95 |
96 | Grab the system_pricing_plans feed.
98 |
99 |
100 | Grab the system_regions feed.
102 |
103 |
104 | Get dataframe of bikeshare feeds released by a city
106 |
107 |
110 |
111 |
112 |
113 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
--------------------------------------------------------------------------------
/docs/pkgdown.css:
--------------------------------------------------------------------------------
1 | /* Sticky footer */
2 |
3 | /**
4 | * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
5 | * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
6 | *
7 | * .Site -> body > .container
8 | * .Site-content -> body > .container .row
9 | * .footer -> footer
10 | *
11 | * Key idea seems to be to ensure that .container and __all its parents__
12 | * have height set to 100%
13 | *
14 | */
15 |
16 | html, body {
17 | height: 100%;
18 | }
19 |
20 | body {
21 | position: relative;
22 | }
23 |
24 | body > .container {
25 | display: flex;
26 | height: 100%;
27 | flex-direction: column;
28 | }
29 |
30 | body > .container .row {
31 | flex: 1 0 auto;
32 | }
33 |
34 | footer {
35 | margin-top: 45px;
36 | padding: 35px 0 36px;
37 | border-top: 1px solid #e5e5e5;
38 | color: #666;
39 | display: flex;
40 | flex-shrink: 0;
41 | }
42 | footer p {
43 | margin-bottom: 0;
44 | }
45 | footer div {
46 | flex: 1;
47 | }
48 | footer .pkgdown {
49 | text-align: right;
50 | }
51 | footer p {
52 | margin-bottom: 0;
53 | }
54 |
55 | img.icon {
56 | float: right;
57 | }
58 |
59 | /* Ensure in-page images don't run outside their container */
60 | .contents img {
61 | max-width: 100%;
62 | height: auto;
63 | }
64 |
65 | /* Fix bug in bootstrap (only seen in firefox) */
66 | summary {
67 | display: list-item;
68 | }
69 |
70 | /* Typographic tweaking ---------------------------------*/
71 |
72 | .contents .page-header {
73 | margin-top: calc(-60px + 1em);
74 | }
75 |
76 | dd {
77 | margin-left: 3em;
78 | }
79 |
80 | /* Section anchors ---------------------------------*/
81 |
82 | a.anchor {
83 | display: none;
84 | margin-left: 5px;
85 | width: 20px;
86 | height: 20px;
87 |
88 | background-image: url(./link.svg);
89 | background-repeat: no-repeat;
90 | background-size: 20px 20px;
91 | background-position: center center;
92 | }
93 |
94 | h1:hover .anchor,
95 | h2:hover .anchor,
96 | h3:hover .anchor,
97 | h4:hover .anchor,
98 | h5:hover .anchor,
99 | h6:hover .anchor {
100 | display: inline-block;
101 | }
102 |
103 | /* Fixes for fixed navbar --------------------------*/
104 |
105 | .contents h1, .contents h2, .contents h3, .contents h4 {
106 | padding-top: 60px;
107 | margin-top: -40px;
108 | }
109 |
110 | /* Navbar submenu --------------------------*/
111 |
112 | .dropdown-submenu {
113 | position: relative;
114 | }
115 |
116 | .dropdown-submenu>.dropdown-menu {
117 | top: 0;
118 | left: 100%;
119 | margin-top: -6px;
120 | margin-left: -1px;
121 | border-radius: 0 6px 6px 6px;
122 | }
123 |
124 | .dropdown-submenu:hover>.dropdown-menu {
125 | display: block;
126 | }
127 |
128 | .dropdown-submenu>a:after {
129 | display: block;
130 | content: " ";
131 | float: right;
132 | width: 0;
133 | height: 0;
134 | border-color: transparent;
135 | border-style: solid;
136 | border-width: 5px 0 5px 5px;
137 | border-left-color: #cccccc;
138 | margin-top: 5px;
139 | margin-right: -10px;
140 | }
141 |
142 | .dropdown-submenu:hover>a:after {
143 | border-left-color: #ffffff;
144 | }
145 |
146 | .dropdown-submenu.pull-left {
147 | float: none;
148 | }
149 |
150 | .dropdown-submenu.pull-left>.dropdown-menu {
151 | left: -100%;
152 | margin-left: 10px;
153 | border-radius: 6px 0 6px 6px;
154 | }
155 |
156 | /* Sidebar --------------------------*/
157 |
158 | #pkgdown-sidebar {
159 | margin-top: 30px;
160 | position: -webkit-sticky;
161 | position: sticky;
162 | top: 70px;
163 | }
164 |
165 | #pkgdown-sidebar h2 {
166 | font-size: 1.5em;
167 | margin-top: 1em;
168 | }
169 |
170 | #pkgdown-sidebar h2:first-child {
171 | margin-top: 0;
172 | }
173 |
174 | #pkgdown-sidebar .list-unstyled li {
175 | margin-bottom: 0.5em;
176 | }
177 |
178 | /* bootstrap-toc tweaks ------------------------------------------------------*/
179 |
180 | /* All levels of nav */
181 |
182 | nav[data-toggle='toc'] .nav > li > a {
183 | padding: 4px 20px 4px 6px;
184 | font-size: 1.5rem;
185 | font-weight: 400;
186 | color: inherit;
187 | }
188 |
189 | nav[data-toggle='toc'] .nav > li > a:hover,
190 | nav[data-toggle='toc'] .nav > li > a:focus {
191 | padding-left: 5px;
192 | color: inherit;
193 | border-left: 1px solid #878787;
194 | }
195 |
196 | nav[data-toggle='toc'] .nav > .active > a,
197 | nav[data-toggle='toc'] .nav > .active:hover > a,
198 | nav[data-toggle='toc'] .nav > .active:focus > a {
199 | padding-left: 5px;
200 | font-size: 1.5rem;
201 | font-weight: 400;
202 | color: inherit;
203 | border-left: 2px solid #878787;
204 | }
205 |
206 | /* Nav: second level (shown on .active) */
207 |
208 | nav[data-toggle='toc'] .nav .nav {
209 | display: none; /* Hide by default, but at >768px, show it */
210 | padding-bottom: 10px;
211 | }
212 |
213 | nav[data-toggle='toc'] .nav .nav > li > a {
214 | padding-left: 16px;
215 | font-size: 1.35rem;
216 | }
217 |
218 | nav[data-toggle='toc'] .nav .nav > li > a:hover,
219 | nav[data-toggle='toc'] .nav .nav > li > a:focus {
220 | padding-left: 15px;
221 | }
222 |
223 | nav[data-toggle='toc'] .nav .nav > .active > a,
224 | nav[data-toggle='toc'] .nav .nav > .active:hover > a,
225 | nav[data-toggle='toc'] .nav .nav > .active:focus > a {
226 | padding-left: 15px;
227 | font-weight: 500;
228 | font-size: 1.35rem;
229 | }
230 |
231 | /* orcid ------------------------------------------------------------------- */
232 |
233 | .orcid {
234 | font-size: 16px;
235 | color: #A6CE39;
236 | /* margins are required by official ORCID trademark and display guidelines */
237 | margin-left:4px;
238 | margin-right:4px;
239 | vertical-align: middle;
240 | }
241 |
242 | /* Reference index & topics ----------------------------------------------- */
243 |
244 | .ref-index th {font-weight: normal;}
245 |
246 | .ref-index td {vertical-align: top; min-width: 100px}
247 | .ref-index .icon {width: 40px;}
248 | .ref-index .alias {width: 40%;}
249 | .ref-index-icons .alias {width: calc(40% - 40px);}
250 | .ref-index .title {width: 60%;}
251 |
252 | .ref-arguments th {text-align: right; padding-right: 10px;}
253 | .ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
254 | .ref-arguments .name {width: 20%;}
255 | .ref-arguments .desc {width: 80%;}
256 |
257 | /* Nice scrolling for wide elements --------------------------------------- */
258 |
259 | table {
260 | display: block;
261 | overflow: auto;
262 | }
263 |
264 | /* Syntax highlighting ---------------------------------------------------- */
265 |
266 | pre, code, pre code {
267 | background-color: #f8f8f8;
268 | color: #333;
269 | }
270 | pre, pre code {
271 | white-space: pre-wrap;
272 | word-break: break-all;
273 | overflow-wrap: break-word;
274 | }
275 |
276 | pre {
277 | border: 1px solid #eee;
278 | }
279 |
280 | pre .img, pre .r-plt {
281 | margin: 5px 0;
282 | }
283 |
284 | pre .img img, pre .r-plt img {
285 | background-color: #fff;
286 | }
287 |
288 | code a, pre a {
289 | color: #375f84;
290 | }
291 |
292 | a.sourceLine:hover {
293 | text-decoration: none;
294 | }
295 |
296 | .fl {color: #1514b5;}
297 | .fu {color: #000000;} /* function */
298 | .ch,.st {color: #036a07;} /* string */
299 | .kw {color: #264D66;} /* keyword */
300 | .co {color: #888888;} /* comment */
301 |
302 | .error {font-weight: bolder;}
303 | .warning {font-weight: bolder;}
304 |
305 | /* Clipboard --------------------------*/
306 |
307 | .hasCopyButton {
308 | position: relative;
309 | }
310 |
311 | .btn-copy-ex {
312 | position: absolute;
313 | right: 0;
314 | top: 0;
315 | visibility: hidden;
316 | }
317 |
318 | .hasCopyButton:hover button.btn-copy-ex {
319 | visibility: visible;
320 | }
321 |
322 | /* headroom.js ------------------------ */
323 |
324 | .headroom {
325 | will-change: transform;
326 | transition: transform 200ms linear;
327 | }
328 | .headroom--pinned {
329 | transform: translateY(0%);
330 | }
331 | .headroom--unpinned {
332 | transform: translateY(-100%);
333 | }
334 |
335 | /* mark.js ----------------------------*/
336 |
337 | mark {
338 | background-color: rgba(255, 255, 51, 0.5);
339 | border-bottom: 2px solid rgba(255, 153, 51, 0.3);
340 | padding: 1px;
341 | }
342 |
343 | /* vertical spacing after htmlwidgets */
344 | .html-widget {
345 | margin-bottom: 10px;
346 | }
347 |
348 | /* fontawesome ------------------------ */
349 |
350 | .fab {
351 | font-family: "Font Awesome 5 Brands" !important;
352 | }
353 |
354 | /* don't display links in code chunks when printing */
355 | /* source: https://stackoverflow.com/a/10781533 */
356 | @media print {
357 | code a:link:after, code a:visited:after {
358 | content: "";
359 | }
360 | }
361 |
362 | /* Section anchors ---------------------------------
363 | Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
364 | */
365 |
366 | div.csl-bib-body { }
367 | div.csl-entry {
368 | clear: both;
369 | }
370 | .hanging-indent div.csl-entry {
371 | margin-left:2em;
372 | text-indent:-2em;
373 | }
374 | div.csl-left-margin {
375 | min-width:2em;
376 | float:left;
377 | }
378 | div.csl-right-inline {
379 | margin-left:2em;
380 | padding-left:1em;
381 | }
382 | div.csl-indent {
383 | margin-left: 2em;
384 | }
385 |
--------------------------------------------------------------------------------
/docs/reference/get_system_pricing_plans.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_pricing_plans feed. — get_system_pricing_plans • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | Grab the system_pricing_plans feed.
49 | Source: R/get_static_feeds.R
50 | get_system_pricing_plans.Rd
51 |
52 |
53 |
54 | get_system_pricing_plans grabs and tidies the system_pricing_plans
55 | feed for a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_pricing_plans(
61 | city,
62 | directory = NULL,
63 | file = "system_pricing_plans.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 |
115 |
116 |
117 |
118 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
--------------------------------------------------------------------------------
/docs/reference/gbfs.html:
--------------------------------------------------------------------------------
1 |
2 | Package: gbfs — gbfs • gbfs
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
53 |
54 |
55 | The gbfs package allows users to query tidy datasets about bikeshare
56 | programs around the world by supplying a set of functions to interface with
57 | .json feeds following the General Bikeshare Feed Specification, a standard
58 | data release format developed by the North American Bikeshare Association.
59 |
60 |
61 |
62 |
63 | Details
64 | The main function exported by this package is get_gbfs(), which
65 | grabs every feed released by a city. Alternatively, the user can just
66 | grab information on specific feeds (or groups of feeds).
67 | Each of the feeds described below can be queried with the get_suffix()
68 | function, where suffix is replaced with the name of the relevant feed.
69 | Although all of the feeds are livestreamed, only a few of the datasets
70 | change often:
71 | station_status:Supplies the number of available bikes and
73 | docks at each station as well as station availability
free_bike_status:Gives the coordinates and metadata on
77 | available bikes that are parked, but not at a station.
In this package, these two datasets are considered "dynamic", and can be
81 | specified as desired datasets by setting `feeds = "dynamic" in the
82 | main wrapper function in the package, get_gbfs.
83 | Much of the data supplied in this specification can be considered static.
84 | If you want to grab all of these for a given city, set feeds = "static"
85 | when calling get_gbfs. Static feeds include:
86 | system_information:Basic metadata about the bikeshare program
station_information:Information on the capacity and coordinates of stations
- Several optional feeds:
93 | system_hours, system_calendar,
94 | system_regions, system_pricing_plans, and system_alerts
98 |
99 | See also
100 | Useful links:
Report bugs at https://github.com/simonpcouch/gbfs/issues
103 |
104 |
110 |
111 |
112 |
115 |
116 |
117 |
118 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
--------------------------------------------------------------------------------
/docs/reference/get_system_hours.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_hours feed. — get_system_hours • gbfs
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
53 |
54 |
55 | get_system_hours grabs and tidies the system_hours
56 | feed for a given city. Metadata for this
57 | dataset can be found at:
58 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
59 |
60 |
61 |
62 | get_system_hours(
63 | city,
64 | directory = NULL,
65 | file = "system_hours.rds",
66 | output = NULL
67 | )
68 |
69 |
70 |
71 | Arguments
72 |
73 |
74 | - city
75 | A character string that can be matched to a gbfs feed. The recommended
76 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
77 | also attempt to match to the URL of an active .json feed or city name.
- directory
81 | Optional. Path to a folder (or folder to be
82 | created) where the feed will be saved.
- file
86 | Optional. The name of the file to be saved (if output
87 | is set to "save" or "both"), as a character string.
88 | Must end in ".rds".
- output
92 | Optional. The type of output method. If left as default, this
93 | argument is inferred from the directory argument. If
94 | output = "save", the object will be saved as an .rds object at
95 | # the given path. If output = "return", the output will be returned
96 | as a dataframe object. Setting output = "both" will do both.
99 |
100 | Value
101 | The output of this function depends on argument to output
102 | and directory. Either a saved .rds object generated from the current
103 | feed, a dataframe object, or both.
104 |
105 |
106 | See also
107 | [get_gbfs()] for a wrapper to call each of the get_feed
108 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
109 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
110 | are released by a given city.
111 |
112 |
113 |
114 | Examples
115 | # grab the system hours feed for portland, oregon
116 | get_system_hours(city =
117 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_hours.json",
118 | output = "return")
119 | #> data frame with 0 columns and 0 rows
120 |
121 |
122 |
123 |
124 |
127 |
128 |
129 |
130 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
--------------------------------------------------------------------------------
/docs/reference/get_system_alerts.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_alerts feed. — get_system_alerts • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
52 |
53 |
54 | get_system_alerts grabs and tidies the system_alerts feed for a given city.
55 | This feed informs users about changes to normal operation. Metadata for this
56 | dataset can be found at: https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_alerts(
61 | city,
62 | directory = NULL,
63 | file = "system_alerts.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 | Examples
113 | # grab the system alerts feed for portland, oregon
114 | get_system_alerts(city =
115 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_alerts.json",
116 | output = "return")
117 | #> data frame with 0 columns and 0 rows
118 |
119 |
120 |
121 |
122 |
125 |
126 |
127 |
128 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
--------------------------------------------------------------------------------
/docs/reference/get_system_calendar.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_calendar feed. — get_system_calendar • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | Grab the system_calendar feed.
49 | Source: R/get_static_feeds.R
50 | get_system_calendar.Rd
51 |
52 |
53 |
54 | get_system_calendar grabs and tidies the system_calendar feed
55 | for a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_calendar(
61 | city,
62 | directory = NULL,
63 | file = "system_calendar.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 | Examples
113 | # grab the system calendar feed for portland, oregon
114 | get_system_calendar(city =
115 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_calendar.json",
116 | output = "return")
117 | #> start_month end_day end_month start_day
118 | #> 1 1 31 12 1
119 |
120 |
121 |
122 |
123 |
124 |
127 |
128 |
129 |
130 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
--------------------------------------------------------------------------------
/docs/reference/get_which_gbfs_feeds.html:
--------------------------------------------------------------------------------
1 |
2 | Get dataframe of bikeshare feeds released by a city — get_which_gbfs_feeds • gbfs
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
49 | Get dataframe of bikeshare feeds released by a city
50 | Source: R/get_gbfs.R
51 | get_which_gbfs_feeds.Rd
52 |
53 |
54 |
55 | Of the different types of feeds supplied by the gbfs,
56 | some are required, some are conditionally required, and some are
57 | optional. This function grabs a list of each of the feeds supplied
58 | by a given city, as well as the URLs to access them.
59 |
60 |
61 |
62 | get_which_gbfs_feeds(city)
63 |
64 |
65 |
66 | Source
67 | North American Bikeshare Association, General Bikeshare Feed
68 | Specification https://github.com/MobilityData/gbfs/blob/master/gbfs.md
69 |
70 |
71 | Arguments
72 |
73 |
74 |
80 |
81 | Value
82 | A data.frame containing the feeds supplied by
83 | a city. . The `feed` column supplies the name of the relevant .json feeds,
84 | while the entries in the `URL` column supply the feeds themselves.
85 |
86 |
87 |
88 | Examples
89 | # grab all of the feeds released by portland
90 | get_which_gbfs_feeds(city = "biketown_pdx")
91 | #> url
92 | #> 1 https://gbfs.lyft.com/gbfs/2.3/pdx/gbfs.json
93 | #> 2 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_information.json
94 | #> 3 https://gbfs.lyft.com/gbfs/2.3/pdx/en/station_information.json
95 | #> 4 https://gbfs.lyft.com/gbfs/2.3/pdx/en/station_status.json
96 | #> 5 https://gbfs.lyft.com/gbfs/2.3/pdx/en/free_bike_status.json
97 | #> 6 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_hours.json
98 | #> 7 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_calendar.json
99 | #> 8 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_regions.json
100 | #> 9 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_pricing_plans.json
101 | #> 10 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_alerts.json
102 | #> 11 https://gbfs.lyft.com/gbfs/2.3/pdx/en/gbfs_versions.json
103 | #> 12 https://gbfs.lyft.com/gbfs/2.3/pdx/en/vehicle_types.json
104 | #> name
105 | #> 1 gbfs
106 | #> 2 system_information
107 | #> 3 station_information
108 | #> 4 station_status
109 | #> 5 free_bike_status
110 | #> 6 system_hours
111 | #> 7 system_calendar
112 | #> 8 system_regions
113 | #> 9 system_pricing_plans
114 | #> 10 system_alerts
115 | #> 11 gbfs_versions
116 | #> 12 vehicle_types
117 |
118 |
119 |
120 |
121 |
124 |
125 |
126 |
127 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
--------------------------------------------------------------------------------
/docs/reference/get_system_regions.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_regions feed. — get_system_regions • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | Grab the system_regions feed.
49 | Source: R/get_static_feeds.R
50 | get_system_regions.Rd
51 |
52 |
53 |
54 | get_system_regions grabs and tidies the system_regions feed for
55 | a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_regions(
61 | city,
62 | directory = NULL,
63 | file = "system_regions.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 | Examples
113 | # we can grab the system regions feed for portland,
114 | # oregon in one of several ways! first, supply the `city`
115 | # argument as a URL, and save to file by leaving output
116 | # set to it's default. usually, we would supply a character
117 | # string (like "pdx", maybe,) for the `directory` argument
118 | # instead of `tempdir`.
119 | get_system_regions(city =
120 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_regions.json",
121 | directory = tempdir())
122 |
123 | # or, instead, just supply the name of
124 | # the city as a string and return the output
125 | # as a dataframe
126 | get_system_regions(city = "biketown_pdx",
127 | output = "return")
128 | #> name region_id
129 | #> 1 PDX PDX
130 |
131 |
132 |
133 |
136 |
137 |
138 |
139 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
--------------------------------------------------------------------------------
`).
76 | getTopLevel: function($scope) {
77 | for (var i = 1; i <= 6; i++) {
78 | var $headings = this.findOrFilter($scope, 'h' + i);
79 | if ($headings.length > 1) {
80 | return i;
81 | }
82 | }
83 |
84 | return 1;
85 | },
86 |
87 | // returns the elements for the top level, and the next below it
88 | getHeadings: function($scope, topLevel) {
89 | var topSelector = 'h' + topLevel;
90 |
91 | var secondaryLevel = topLevel + 1;
92 | var secondarySelector = 'h' + secondaryLevel;
93 |
94 | return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
95 | },
96 |
97 | getNavLevel: function(el) {
98 | return parseInt(el.tagName.charAt(1), 10);
99 | },
100 |
101 | populateNav: function($topContext, topLevel, $headings) {
102 | var $context = $topContext;
103 | var $prevNav;
104 |
105 | var helpers = this;
106 | $headings.each(function(i, el) {
107 | var $newNav = helpers.generateNavItem(el);
108 | var navLevel = helpers.getNavLevel(el);
109 |
110 | // determine the proper $context
111 | if (navLevel === topLevel) {
112 | // use top level
113 | $context = $topContext;
114 | } else if ($prevNav && $context === $topContext) {
115 | // create a new level of the tree and switch to it
116 | $context = helpers.createChildNavList($prevNav);
117 | } // else use the current $context
118 |
119 | $context.append($newNav);
120 |
121 | $prevNav = $newNav;
122 | });
123 | },
124 |
125 | parseOps: function(arg) {
126 | var opts;
127 | if (arg.jquery) {
128 | opts = {
129 | $nav: arg
130 | };
131 | } else {
132 | opts = arg;
133 | }
134 | opts.$scope = opts.$scope || $(document.body);
135 | return opts;
136 | }
137 | },
138 |
139 | // accepts a jQuery object, or an options object
140 | init: function(opts) {
141 | opts = this.helpers.parseOps(opts);
142 |
143 | // ensure that the data attribute is in place for styling
144 | opts.$nav.attr('data-toggle', 'toc');
145 |
146 | var $topContext = this.helpers.createChildNavList(opts.$nav);
147 | var topLevel = this.helpers.getTopLevel(opts.$scope);
148 | var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
149 | this.helpers.populateNav($topContext, topLevel, $headings);
150 | }
151 | };
152 |
153 | $(function() {
154 | $('nav[data-toggle="toc"]').each(function(i, el) {
155 | var $nav = $(el);
156 | Toc.init($nav);
157 | });
158 | });
159 | })();
160 |
--------------------------------------------------------------------------------
/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 | Page not found (404) • gbfs
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
25 |
26 |
27 |
28 |
29 |
30 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 | Page not found (404)
75 |
76 |
77 | Content not found. Please use links in the navbar.
78 |
79 |
80 |
81 |
85 |
86 |
87 |
88 |
89 |
90 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
--------------------------------------------------------------------------------
/docs/authors.html:
--------------------------------------------------------------------------------
1 |
2 | Authors and Citation • gbfs
6 |
7 |
8 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
--------------------------------------------------------------------------------
/docs/reference/get_gbfs_cities.html:
--------------------------------------------------------------------------------
1 |
2 | Get table of all cities releasing GBFS feeds — get_gbfs_cities • gbfs
6 |
7 |
8 |
9 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Get table of all cities releasing GBFS feeds
47 | Source: R/get_gbfs.R
48 | get_gbfs_cities.Rd
49 |
50 |
51 |
52 | Get table of all cities releasing GBFS feeds
53 |
54 |
55 |
56 | get_gbfs_cities()
57 |
58 |
59 |
60 | Source
61 | North American Bikeshare Association, General Bikeshare Feed Specification
62 | https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv
63 |
64 |
65 | Value
66 | A data.frame of all cities issuing GBFS feeds. The `Auto-Discovery URL`
67 | column supplies the relevant .json feeds, while the entries in the `URL` column
68 | take the user to the public-facing webpage of the programs.
69 |
70 |
71 |
72 |
75 |
76 |
77 |
78 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 |
95 |
--------------------------------------------------------------------------------
/docs/CONTRIBUTING.html:
--------------------------------------------------------------------------------
1 |
2 | Contributor Code of Conduct • gbfs
6 |
7 |
8 |
9 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Contributor Code of Conduct
47 |
48 |
49 |
50 |
51 | As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
52 | We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
53 | Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
54 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct.
55 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
56 | This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html
57 |
58 |
59 |
60 |
61 |
64 |
65 |
66 |
67 |
68 |
69 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
--------------------------------------------------------------------------------
/R/get_gbfs.R:
--------------------------------------------------------------------------------
1 | #' Get table of all cities releasing GBFS feeds
2 | #'
3 | #' @return A \code{data.frame} of all cities issuing GBFS feeds. The `Auto-Discovery URL`
4 | #' column supplies the relevant .json feeds, while the entries in the `URL` column
5 | #' take the user to the public-facing webpage of the programs.
6 | #' @source North American Bikeshare Association, General Bikeshare Feed Specification
7 | #' \url{https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv}
8 | #' @export
9 | get_gbfs_cities <- function() {
10 |
11 | # test internet connection
12 | if (!connected_to_internet()) {
13 | return(message_no_internet())
14 | }
15 |
16 | # specify column types
17 | systems_cols <- readr::cols(
18 | `Country Code` = readr::col_character(),
19 | "Name" = readr::col_character(),
20 | "Location" = readr::col_character(),
21 | `System ID` = readr::col_character(),
22 | `URL` = readr::col_character(),
23 | `Auto-Discovery URL` = readr::col_character()
24 | )
25 |
26 | # grab the data
27 | readr::read_csv("https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv",
28 | col_types = systems_cols)
29 | }
30 |
31 |
32 |
33 | #' Get dataframe of bikeshare feeds released by a city
34 | #'
35 | #' @description Of the different types of feeds supplied by the gbfs,
36 | #' some are required, some are conditionally required, and some are
37 | #' optional. This function grabs a list of each of the feeds supplied
38 | #' by a given city, as well as the URLs to access them.
39 | #'
40 | #' @param city A character string that can be matched to a gbfs feed. The recommended
41 | #' argument is a system ID supplied in the output of [get_gbfs_cities()], but will
42 | #' also attempt to match to the URL of an active .json feed or city name.
43 | #'
44 | #' @return A \code{data.frame} containing the feeds supplied by
45 | #' a city. . The `feed` column supplies the name of the relevant .json feeds,
46 | #' while the entries in the `URL` column supply the feeds themselves.
47 | #'
48 | #' @source North American Bikeshare Association, General Bikeshare Feed
49 | #' Specification \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
50 | #'
51 | #' @examples
52 | #' # grab all of the feeds released by portland
53 | #' \donttest{get_which_gbfs_feeds(city = "biketown_pdx")}
54 | #'
55 | #' @export
56 | get_which_gbfs_feeds <- function(city) {
57 |
58 | # test internet connection
59 | if (!connected_to_internet()) {
60 | return(message_no_internet())
61 | }
62 |
63 | # convert the city argument to a URL
64 | url <- city_to_url(city, "gbfs")
65 |
66 | # grab the relevant data
67 | gbfs <- tryCatch(jsonlite::fromJSON(txt = url),
68 | error = report_connection_issue)
69 |
70 | # pull out the dataset
71 | gbfs_feeds <- gbfs[["data"]][[1]][[1]]
72 |
73 | # ...and return it!
74 | return(gbfs_feeds)
75 |
76 | }
77 |
78 | #' Grab bikeshare data
79 | #'
80 | #' \code{get_gbfs} grabs bikeshare data supplied in the General Bikeshare
81 | #' Feed Specification format for a given city. By default, the function returns
82 | #' the results as a named list of dataframes, but to make accumulation of
83 | #' datasets over time straightforward, the user can also save the results
84 | #' as .Rds files that will be automatically row-binded.
85 | #' Metadata for each dataset can be found at:
86 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
87 | #'
88 | #' @param city A character string that can be matched to a city or a url to an
89 | #' active gbfs.json feed. See \code{get_gbfs_cities} for a current list of available cities.
90 | #' @param feeds Optional. A character string specifying which feeds should be saved.
91 | #' Options are \code{"all"}, \code{"static"}, and \code{"dynamic"}.
92 | #' @param directory Optional. Path to a folder (or folder to be created) where
93 | #' the feed will will be saved.
94 | #' @param output Optional. The type of output method. By default, output method
95 | #' will be inferred from the \code{directory} argument. If \code{output = "save"},
96 | #' the dataframes will be saved as .rds objects in the given folder. If
97 | #' \code{output = "return"}, the results will be returned as a named list of
98 | #' dataframes. Setting \code{output = "both"} will do both. If both are left
99 | #' as NULL, the result will be returned and not saved to file.
100 | #' @return The output of this function depends on the arguments supplied to
101 | #' \code{output} and \code{directory}. Either a folder of .rds dataframes saved
102 | #' at the given path, a returned named list of dataframes, or both.
103 | #' The function will raise an error if the \code{directory} and \code{output}
104 | #' arguments seem to conflict.
105 | #' @examples
106 | #' # grab all of the feeds released by portland's
107 | #' # bikeshare program and return them as a
108 | #' # named list of dataframes
109 | #' \donttest{get_gbfs(city = "biketown_pdx")}
110 | #'
111 | #' # if, rather than returning the data, we wanted to save it:
112 | #' \donttest{get_gbfs(city = "biketown_pdx", directory = tempdir())}
113 | #'
114 | #' # note that, usually, we'd supply a character string
115 | #' # (like "pdx", maybe,) to the directory argument
116 | #' # instead of `tempdir()`.
117 | #'
118 | #' # if we're having trouble specifying the correct feed,
119 | #' # we can also supply the actual URL to the feed
120 | #' \donttest{get_gbfs(city = "https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json")}
121 | #'
122 | #' # the examples above grab every feed that portland releases.
123 | #' # if, instead, we just wanted the dynamic feeds
124 | #' \donttest{get_gbfs(city = "biketown_pdx", feeds = "dynamic")}
125 | #' @export
126 | get_gbfs <- function(city, feeds = "all", directory = NULL, output = NULL) {
127 |
128 | # test internet connection
129 | if (!connected_to_internet()) {
130 | return(message_no_internet())
131 | }
132 |
133 | # check the "feeds" argument
134 | feeds <- process_feeds_argument(feeds)
135 |
136 | # figure out how to output the resulting object
137 | output_types <- determine_output_types(directory, output)
138 |
139 | # check that, if the user said to save the file, they also
140 | # supplied a directory
141 | if (output_types[1] & is.null(directory)) {
142 | stop(sprintf(c("The argument to output suggests that the resulting",
143 | " data should be saved, but a directory to save the",
144 | " outputs in hasn't been supplied. Please supply",
145 | " an argument to directory or leave the output argument",
146 | " as default.")))
147 | }
148 |
149 | # convert the city argument to a top-level gbfs url
150 | url <- city_to_url(city, "gbfs")
151 |
152 | # figure out which feeds are available
153 | available_feeds <- get_which_gbfs_feeds(city = url)
154 |
155 | # ...and then figure out which of them to grab
156 | relevant_feeds <- available_feeds %>%
157 | dplyr::left_join(all_feeds, by = "name") %>%
158 | dplyr::filter(type %in% feeds) %>%
159 | dplyr::select(name) %>%
160 | dplyr::pull()
161 |
162 | # grab all of the relevant feeds! note that this will save each
163 | # of the datasets in the directory folder if directory is
164 | # something other than NULL
165 | data <- suppressMessages(
166 | purrr::map2(paste0(relevant_feeds, ".Rds"),
167 | relevant_feeds,
168 | get_gbfs_dataset_,
169 | city = url,
170 | directory = directory,
171 | output = NULL)
172 | )
173 |
174 | # name each of the elements so that they're more easily accessible
175 | names(data) <- relevant_feeds
176 |
177 | # output the datasets as desired :-)
178 | if (output_types[2]) {
179 | return(data)
180 | }
181 | }
182 |
183 |
--------------------------------------------------------------------------------
/README.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | output: github_document
3 | ---
4 |
5 | ```{r, echo = FALSE, message = FALSE}
6 | knitr::opts_chunk$set(
7 | collapse = TRUE,
8 | comment = "#>",
9 | fig.path = "figures/"
10 | )
11 | devtools::load_all()
12 | ```
13 |
14 | # General Bikeshare Feed Specification
15 |
16 | [](https://cran.r-project.org/package=gbfs)
17 | [](https://github.com/simonpcouch/gbfs/actions)
18 | [](https://cran.r-project.org/package=gbfs)
19 |
20 | The `gbfs` package supplies a set of functions to interface with General
21 | Bikeshare Feed Specification .json feeds in R, allowing users to save
22 | and accumulate tidy .rds datasets for specified cities/bikeshare programs.
23 | The North American Bikeshare Association's [gbfs](https://github.com/MobilityData/gbfs)
24 | is a standardized data release format for live information on the status
25 | of bikeshare programs, as well as metadata, including counts of bikes at
26 | stations, ridership costs, and geographic locations of stations and
27 | parked bikes.
28 |
29 | __Features__
30 |
31 | * Get bikeshare data by specifying city name or supplying url of feed
32 | * All feeds for a city can be saved with a single function
33 | * New information from dynamic feeds can be appended to existing datasets
34 |
35 | ## Installation
36 |
37 | We're on CRAN! Install the latest release with:
38 |
39 | ```{r cran-installation, eval = FALSE}
40 | install.packages("gbfs")
41 | library(gbfs)
42 | ```
43 |
44 | You can install the developmental version of `gbfs` from GitHub with:
45 |
46 | ```{r gh-installation, eval = FALSE}
47 | # install.packages("devtools")
48 | devtools::install_github("simonpcouch/gbfs")
49 | ```
50 |
51 | ## Background
52 |
53 | The `gbfs` is a standardized data feed describing the current status of a
54 | bikeshare program.
55 |
56 | Although all of the data is live, only a few of the datasets change often:
57 |
58 | * `station_status`: Supplies the number of available bikes and
59 | docks at each station as well as station availability
60 | * `free_bike_status`: Gives the coordinates and metadata on available
61 | bikes that are parked, but not at a station.
62 |
63 | In this package, these two datasets are considered "dynamic", and can be
64 | specified as desired datasets by setting `feeds = "dynamic"` in the
65 | main wrapper function in the package, `get_gbfs`.
66 |
67 | Much of the data supplied in this specification can be considered static. If you
68 | want to grab all of these for a given city, set `feeds = "static"` when calling
69 | `get_gbfs`. Static feeds include:
70 |
71 | * `system_information`: Basic metadata about the bikeshare program
72 | * `station_information`: Information on the capacity and coordinates of stations
73 | * Several optional feeds: `system_hours`, `system_calendar`, `system_regions`,
74 | `system_pricing_plans`, and `system_alerts`
75 |
76 | Each of the above feeds can be queried with the `get_suffix` function, where
77 | `suffix` is replaced with the name of the relevant feed.
78 |
79 | For more details on the official `gbfs` spec, see
80 | [this document](https://github.com/MobilityData/gbfs/blob/master/gbfs.md).
81 |
82 | ## Example
83 |
84 | In this example, we'll grab data from Portland, Oregon's Biketown bikeshare
85 | program and visualize some of the different datasets.
86 |
87 | ```{r, warning = FALSE, message = FALSE}
88 | # load necessary packages
89 | library(tidyverse)
90 | ```
91 |
92 |
93 | First, we'll grab some information on the stations.
94 |
95 | ```{r}
96 | # grab portland station information and return it as a dataframe
97 | pdx_station_info <-
98 | get_station_information("https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json")
99 |
100 | # check it out!
101 | glimpse(pdx_station_info)
102 | ```
103 |
104 | ...as well as the number of bikes at each station.
105 |
106 | ```{r}
107 | # grab current capacity at each station and return it as a dataframe
108 | pdx_station_status <-
109 | get_station_status("https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json")
110 |
111 | # check it out!
112 | glimpse(pdx_station_status)
113 | ```
114 |
115 | Just like that, we have two tidy datasets containing information about
116 | Portland's bikeshare program.
117 |
118 | Joining these datasets, we can get the capacity at each station, along with each
119 | station's metadata.
120 |
121 | ```{r}
122 | # full join these two datasets on station_id and select a few columns
123 | pdx_stations <- full_join(pdx_station_info,
124 | pdx_station_status,
125 | by = "station_id") %>%
126 | # just select columns we're interested in visualizing
127 | select(id = station_id,
128 | lon,
129 | lat,
130 | num_bikes_available,
131 | num_docks_available) %>%
132 | mutate(type = "docked")
133 | ```
134 |
135 | Finally, before we plot, lets grab the locations of the bikes parked in
136 | Portland that are not docked at a station,
137 |
138 | ```{r}
139 | # grab data on free bike status and save it as a dataframe
140 | pdx_free_bikes <-
141 | get_free_bike_status("https://gbfs.lyft.com/gbfs/1.1/pdx/gbfs.json",
142 | output = "return") %>%
143 | # just select columns we're interested in visualizing
144 | select(id = bike_id, lon, lat) %>%
145 | # make columns analogous to station_status for row binding
146 | mutate(num_bikes_available = 1,
147 | num_docks_available = NA,
148 | type = "free")
149 | ```
150 |
151 | ...and bind these dataframes together!
152 |
153 | ```{r}
154 | # row bind stationed and free bike info
155 | pdx_full <- bind_rows(pdx_stations, pdx_free_bikes)
156 | ```
157 |
158 | Now, plotting,
159 |
160 | ```{r plot}
161 | # filter out stations with 0 available bikes
162 | pdx_plot <- pdx_full %>%
163 | filter(num_bikes_available > 0) %>%
164 | # plot the geospatial distribution of bike counts
165 | ggplot() +
166 | aes(x = lon,
167 | y = lat,
168 | size = num_bikes_available,
169 | col = type) +
170 | geom_point() +
171 | # make aesthetics slightly more cozy
172 | theme_minimal() +
173 | scale_color_brewer(type = "qual")
174 | ```
175 |
176 | ```{r print-plot, eval = FALSE}
177 | pdx_plot
178 | ```
179 |
180 |
181 |
182 | Folks who have spent a significant amount of time in Portland might be able to
183 | pick out the Willamette River running Northwest/Southeast through the city.
184 | With a few lines of `gbfs`, `dplyr`, and `ggplot2`, we can put together a
185 | meaningful visualization to help us better understand how bikeshare bikes
186 | are distributed throughout Portland.
187 |
188 | Some other features worth playing around with in `gbfs` that weren't touched
189 | on in this example:
190 |
191 | * The main wrapper function in the package, `get_gbfs`, will grab every
192 | dataset for a given city. (We call the functions to grab individual datasets
193 | above for clarity.)
194 | * In the above lines, we output the datasets as returned dataframes. If you'd
195 | rather save the output to your local files, check out the `directory` and
196 | `return` arguments.
197 | * When the `output` argument is left as default in `get_free_bike_status` and
198 | `get_station_status` (the functions for the `dynamic` dataframes,)
199 | and a dataframe already exists at the given path, `gbfs` will row bind the
200 | dataframes, allowing for the capability to accumulate large datasets over time.
201 | * If you're not sure if your city supplies `gbfs` feeds, you might find the
202 | `get_gbfs_cities` and `get_which_gbfs_feeds` functions useful.
203 |
204 | ## Contributing
205 |
206 | Please note that the `gbfs` R package is released with a [Contributor Code of Conduct](CONTRIBUTING.md). By contributing to this project, you agree to abide by its terms.
207 |
--------------------------------------------------------------------------------
/R/get_static_feeds.R:
--------------------------------------------------------------------------------
1 | #' Grab the station_information feed.
2 | #'
3 | #' \code{get_station_information} grabs and tidies the station_information feed for a given city.
4 | #' This dataset contains locations, capacity, and other information about bikeshare stations.
5 | #' Metadata for this dataset can be found at:
6 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
7 | #'
8 | #' @param city A character string that can be matched to a gbfs feed. The recommended
9 | #' argument is a system ID supplied in the output of [get_gbfs_cities()], but will
10 | #' also attempt to match to the URL of an active .json feed or city name.
11 | #' @param directory Optional. Path to a folder (or folder to be
12 | #' created) where the feed will be saved.
13 | #' @param file Optional. The name of the file to be saved (if \code{output}
14 | #' is set to \code{"save"} or \code{"both"}), as a character string.
15 | #' Must end in \code{".rds"}.
16 | #' @param output Optional. The type of output method. If left as default, this
17 | #' argument is inferred from the \code{directory} argument. If
18 | #' \code{output = "save"}, the object will be saved as an .rds object at
19 | #' # the given path. If \code{output = "return"}, the output will be returned
20 | #' as a dataframe object. Setting \code{output = "both"} will do both.
21 | #'
22 | #' @return The output of this function depends on argument to \code{output}
23 | #' and \code{directory}. Either a saved .rds object generated from the current
24 | #' feed, a dataframe object, or both.
25 | #'
26 | #' @seealso [get_gbfs()] for a wrapper to call each of the \code{get_feed}
27 | #' functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
28 | #' functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
29 | #' are released by a given city.
30 | #'
31 | #' @examples
32 | #' # grab the free bike status feed for portland, oreoon's bikeshare program
33 | #' \donttest{get_station_information(city =
34 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/station_information.json",
35 | #' output = "return")}
36 | #'
37 | #' @export
38 | get_station_information <- function(city, directory = NULL, file = "station_information.rds", output = NULL) {
39 |
40 | get_gbfs_dataset_(city, directory, file, output, feed = "station_information")
41 |
42 | }
43 |
44 | #' Grab the system_alerts feed.
45 | #'
46 | #' \code{get_system_alerts} grabs and tidies the system_alerts feed for a given city.
47 | #' This feed informs users about changes to normal operation. Metadata for this
48 | #' dataset can be found at: \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
49 | #'
50 | #' @inherit get_station_information params return seealso
51 | #'
52 | #' @examples
53 | #' # grab the system alerts feed for portland, oregon
54 | #' \donttest{get_system_alerts(city =
55 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_alerts.json",
56 | #' output = "return")}
57 | #'
58 | #' @export
59 |
60 | get_system_alerts <- function (city, directory = NULL, file = "system_alerts.rds", output = NULL) {
61 |
62 | get_gbfs_dataset_(city, directory, file, output, feed = "system_alerts")
63 |
64 | }
65 |
66 | #' Grab the system_calendar feed.
67 | #'
68 | #' \code{get_system_calendar} grabs and tidies the system_calendar feed
69 | #' for a given city. Metadata for this dataset can be found at:
70 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
71 | #'
72 | #' @inherit get_station_information params return seealso
73 | #'
74 | #' @examples
75 | #' # grab the system calendar feed for portland, oregon
76 | #' \donttest{get_system_calendar(city =
77 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_calendar.json",
78 | #' output = "return")}
79 | #'
80 | #'
81 | #' @export
82 |
83 | get_system_calendar <- function (city, directory = NULL, file = "system_calendar.rds", output = NULL) {
84 |
85 | get_gbfs_dataset_(city, directory, file, output, feed = "system_calendar")
86 |
87 | }
88 |
89 | #' Grab the system_hours feed.
90 | #'
91 | #' \code{get_system_hours} grabs and tidies the system_hours
92 | #' feed for a given city. Metadata for this
93 | #' dataset can be found at:
94 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
95 | #'
96 | #' @inherit get_station_information params return seealso
97 | #'
98 | #' @examples
99 | #' # grab the system hours feed for portland, oregon
100 | #' \donttest{get_system_hours(city =
101 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_hours.json",
102 | #' output = "return")}
103 | #'
104 | #' @export
105 |
106 | get_system_hours <- function (city, directory = NULL, file = "system_hours.rds", output = NULL) {
107 |
108 | get_gbfs_dataset_(city, directory, file, output, feed = "system_hours")
109 |
110 | }
111 |
112 | #' Grab the system_information feed.
113 | #'
114 | #' \code{get_system_information} grabs and tidies the system_information
115 | #' feed for a given city. Metadata for this dataset can be found at:
116 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
117 | #'
118 | #' @inherit get_station_information params return seealso
119 | #'
120 | #' @examples
121 | #' # we can grab the free bike status feed for portland,
122 | #' # oregon's bikeshare program in several ways! first, supply the `city`
123 | #' # argument as a URL, and save to file by leaving output
124 | #' # set to it's default. usually, we would supply a character
125 | #' # string (like "pdx", maybe,) for the `directory` argument
126 | #' # instead of `tempdir`.
127 | #' \donttest{get_system_information(city =
128 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_information.json",
129 | #' directory = tempdir())}
130 | #'
131 | #' # or, instead, just supply the name of
132 | #' # the city as a string and return the output as a dataframe
133 | #'\donttest{get_system_information(city = "biketown_pdx",
134 | #' output = "return")}
135 | #' @export
136 |
137 | get_system_information <- function(city, directory = NULL, file = "system_information.rds", output = NULL){
138 |
139 | get_gbfs_dataset_(city, directory, file, output, feed = "system_information")
140 |
141 | }
142 |
143 | #' Grab the system_pricing_plans feed.
144 | #'
145 | #' \code{get_system_pricing_plans} grabs and tidies the system_pricing_plans
146 | #' feed for a given city. Metadata for this dataset can be found at:
147 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
148 | #'
149 | #' @inherit get_station_information params return seealso
150 | #'
151 | #' @export
152 |
153 | get_system_pricing_plans <- function(city, directory = NULL, file = "system_pricing_plans.rds", output = NULL) {
154 |
155 | get_gbfs_dataset_(city, directory, file, output, feed = "system_pricing_plans")
156 |
157 | }
158 |
159 | #' Grab the system_regions feed.
160 | #'
161 | #' \code{get_system_regions} grabs and tidies the system_regions feed for
162 | #' a given city. Metadata for this dataset can be found at:
163 | #' \url{https://github.com/MobilityData/gbfs/blob/master/gbfs.md}
164 | #'
165 | #' @inherit get_station_information params return seealso
166 | #'
167 | #' @examples
168 | #' # we can grab the system regions feed for portland,
169 | #' # oregon in one of several ways! first, supply the `city`
170 | #' # argument as a URL, and save to file by leaving output
171 | #' # set to it's default. usually, we would supply a character
172 | #' # string (like "pdx", maybe,) for the `directory` argument
173 | #' # instead of `tempdir`.
174 | #' \donttest{get_system_regions(city =
175 | #' "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_regions.json",
176 | #' directory = tempdir())}
177 | #'
178 | #' # or, instead, just supply the name of
179 | #' # the city as a string and return the output
180 | #' # as a dataframe
181 | #'\donttest{get_system_regions(city = "biketown_pdx",
182 | #' output = "return")}
183 | #' @export
184 | get_system_regions <- function(city, directory = NULL, file = "system_regions.rds", output = NULL) {
185 |
186 | get_gbfs_dataset_(city, directory, file, output, feed = "system_regions")
187 |
188 | }
189 |
--------------------------------------------------------------------------------
/docs/reference/index.html:
--------------------------------------------------------------------------------
1 |
2 | Package index • gbfs
6 |
7 |
8 |
9 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Reference
47 |
48 |
49 |
50 | All functions
51 |
52 |
53 |
54 |
55 |
56 | Package: gbfs
58 |
59 |
60 | Grab the free_bike_status feed.
62 |
63 |
64 | Grab bikeshare data
66 |
67 |
68 | Get table of all cities releasing GBFS feeds
70 |
71 |
72 | Grab the station_information feed.
74 |
75 |
76 | Grab the station_status feed.
78 |
79 |
80 | Grab the system_alerts feed.
82 |
83 |
84 | Grab the system_calendar feed.
86 |
87 |
88 | Grab the system_hours feed.
90 |
91 |
92 | Grab the system_information feed.
94 |
95 |
96 | Grab the system_pricing_plans feed.
98 |
99 |
100 | Grab the system_regions feed.
102 |
103 |
104 | Get dataframe of bikeshare feeds released by a city
106 |
107 |
110 |
111 |
112 |
113 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
--------------------------------------------------------------------------------
/docs/pkgdown.css:
--------------------------------------------------------------------------------
1 | /* Sticky footer */
2 |
3 | /**
4 | * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
5 | * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
6 | *
7 | * .Site -> body > .container
8 | * .Site-content -> body > .container .row
9 | * .footer -> footer
10 | *
11 | * Key idea seems to be to ensure that .container and __all its parents__
12 | * have height set to 100%
13 | *
14 | */
15 |
16 | html, body {
17 | height: 100%;
18 | }
19 |
20 | body {
21 | position: relative;
22 | }
23 |
24 | body > .container {
25 | display: flex;
26 | height: 100%;
27 | flex-direction: column;
28 | }
29 |
30 | body > .container .row {
31 | flex: 1 0 auto;
32 | }
33 |
34 | footer {
35 | margin-top: 45px;
36 | padding: 35px 0 36px;
37 | border-top: 1px solid #e5e5e5;
38 | color: #666;
39 | display: flex;
40 | flex-shrink: 0;
41 | }
42 | footer p {
43 | margin-bottom: 0;
44 | }
45 | footer div {
46 | flex: 1;
47 | }
48 | footer .pkgdown {
49 | text-align: right;
50 | }
51 | footer p {
52 | margin-bottom: 0;
53 | }
54 |
55 | img.icon {
56 | float: right;
57 | }
58 |
59 | /* Ensure in-page images don't run outside their container */
60 | .contents img {
61 | max-width: 100%;
62 | height: auto;
63 | }
64 |
65 | /* Fix bug in bootstrap (only seen in firefox) */
66 | summary {
67 | display: list-item;
68 | }
69 |
70 | /* Typographic tweaking ---------------------------------*/
71 |
72 | .contents .page-header {
73 | margin-top: calc(-60px + 1em);
74 | }
75 |
76 | dd {
77 | margin-left: 3em;
78 | }
79 |
80 | /* Section anchors ---------------------------------*/
81 |
82 | a.anchor {
83 | display: none;
84 | margin-left: 5px;
85 | width: 20px;
86 | height: 20px;
87 |
88 | background-image: url(./link.svg);
89 | background-repeat: no-repeat;
90 | background-size: 20px 20px;
91 | background-position: center center;
92 | }
93 |
94 | h1:hover .anchor,
95 | h2:hover .anchor,
96 | h3:hover .anchor,
97 | h4:hover .anchor,
98 | h5:hover .anchor,
99 | h6:hover .anchor {
100 | display: inline-block;
101 | }
102 |
103 | /* Fixes for fixed navbar --------------------------*/
104 |
105 | .contents h1, .contents h2, .contents h3, .contents h4 {
106 | padding-top: 60px;
107 | margin-top: -40px;
108 | }
109 |
110 | /* Navbar submenu --------------------------*/
111 |
112 | .dropdown-submenu {
113 | position: relative;
114 | }
115 |
116 | .dropdown-submenu>.dropdown-menu {
117 | top: 0;
118 | left: 100%;
119 | margin-top: -6px;
120 | margin-left: -1px;
121 | border-radius: 0 6px 6px 6px;
122 | }
123 |
124 | .dropdown-submenu:hover>.dropdown-menu {
125 | display: block;
126 | }
127 |
128 | .dropdown-submenu>a:after {
129 | display: block;
130 | content: " ";
131 | float: right;
132 | width: 0;
133 | height: 0;
134 | border-color: transparent;
135 | border-style: solid;
136 | border-width: 5px 0 5px 5px;
137 | border-left-color: #cccccc;
138 | margin-top: 5px;
139 | margin-right: -10px;
140 | }
141 |
142 | .dropdown-submenu:hover>a:after {
143 | border-left-color: #ffffff;
144 | }
145 |
146 | .dropdown-submenu.pull-left {
147 | float: none;
148 | }
149 |
150 | .dropdown-submenu.pull-left>.dropdown-menu {
151 | left: -100%;
152 | margin-left: 10px;
153 | border-radius: 6px 0 6px 6px;
154 | }
155 |
156 | /* Sidebar --------------------------*/
157 |
158 | #pkgdown-sidebar {
159 | margin-top: 30px;
160 | position: -webkit-sticky;
161 | position: sticky;
162 | top: 70px;
163 | }
164 |
165 | #pkgdown-sidebar h2 {
166 | font-size: 1.5em;
167 | margin-top: 1em;
168 | }
169 |
170 | #pkgdown-sidebar h2:first-child {
171 | margin-top: 0;
172 | }
173 |
174 | #pkgdown-sidebar .list-unstyled li {
175 | margin-bottom: 0.5em;
176 | }
177 |
178 | /* bootstrap-toc tweaks ------------------------------------------------------*/
179 |
180 | /* All levels of nav */
181 |
182 | nav[data-toggle='toc'] .nav > li > a {
183 | padding: 4px 20px 4px 6px;
184 | font-size: 1.5rem;
185 | font-weight: 400;
186 | color: inherit;
187 | }
188 |
189 | nav[data-toggle='toc'] .nav > li > a:hover,
190 | nav[data-toggle='toc'] .nav > li > a:focus {
191 | padding-left: 5px;
192 | color: inherit;
193 | border-left: 1px solid #878787;
194 | }
195 |
196 | nav[data-toggle='toc'] .nav > .active > a,
197 | nav[data-toggle='toc'] .nav > .active:hover > a,
198 | nav[data-toggle='toc'] .nav > .active:focus > a {
199 | padding-left: 5px;
200 | font-size: 1.5rem;
201 | font-weight: 400;
202 | color: inherit;
203 | border-left: 2px solid #878787;
204 | }
205 |
206 | /* Nav: second level (shown on .active) */
207 |
208 | nav[data-toggle='toc'] .nav .nav {
209 | display: none; /* Hide by default, but at >768px, show it */
210 | padding-bottom: 10px;
211 | }
212 |
213 | nav[data-toggle='toc'] .nav .nav > li > a {
214 | padding-left: 16px;
215 | font-size: 1.35rem;
216 | }
217 |
218 | nav[data-toggle='toc'] .nav .nav > li > a:hover,
219 | nav[data-toggle='toc'] .nav .nav > li > a:focus {
220 | padding-left: 15px;
221 | }
222 |
223 | nav[data-toggle='toc'] .nav .nav > .active > a,
224 | nav[data-toggle='toc'] .nav .nav > .active:hover > a,
225 | nav[data-toggle='toc'] .nav .nav > .active:focus > a {
226 | padding-left: 15px;
227 | font-weight: 500;
228 | font-size: 1.35rem;
229 | }
230 |
231 | /* orcid ------------------------------------------------------------------- */
232 |
233 | .orcid {
234 | font-size: 16px;
235 | color: #A6CE39;
236 | /* margins are required by official ORCID trademark and display guidelines */
237 | margin-left:4px;
238 | margin-right:4px;
239 | vertical-align: middle;
240 | }
241 |
242 | /* Reference index & topics ----------------------------------------------- */
243 |
244 | .ref-index th {font-weight: normal;}
245 |
246 | .ref-index td {vertical-align: top; min-width: 100px}
247 | .ref-index .icon {width: 40px;}
248 | .ref-index .alias {width: 40%;}
249 | .ref-index-icons .alias {width: calc(40% - 40px);}
250 | .ref-index .title {width: 60%;}
251 |
252 | .ref-arguments th {text-align: right; padding-right: 10px;}
253 | .ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
254 | .ref-arguments .name {width: 20%;}
255 | .ref-arguments .desc {width: 80%;}
256 |
257 | /* Nice scrolling for wide elements --------------------------------------- */
258 |
259 | table {
260 | display: block;
261 | overflow: auto;
262 | }
263 |
264 | /* Syntax highlighting ---------------------------------------------------- */
265 |
266 | pre, code, pre code {
267 | background-color: #f8f8f8;
268 | color: #333;
269 | }
270 | pre, pre code {
271 | white-space: pre-wrap;
272 | word-break: break-all;
273 | overflow-wrap: break-word;
274 | }
275 |
276 | pre {
277 | border: 1px solid #eee;
278 | }
279 |
280 | pre .img, pre .r-plt {
281 | margin: 5px 0;
282 | }
283 |
284 | pre .img img, pre .r-plt img {
285 | background-color: #fff;
286 | }
287 |
288 | code a, pre a {
289 | color: #375f84;
290 | }
291 |
292 | a.sourceLine:hover {
293 | text-decoration: none;
294 | }
295 |
296 | .fl {color: #1514b5;}
297 | .fu {color: #000000;} /* function */
298 | .ch,.st {color: #036a07;} /* string */
299 | .kw {color: #264D66;} /* keyword */
300 | .co {color: #888888;} /* comment */
301 |
302 | .error {font-weight: bolder;}
303 | .warning {font-weight: bolder;}
304 |
305 | /* Clipboard --------------------------*/
306 |
307 | .hasCopyButton {
308 | position: relative;
309 | }
310 |
311 | .btn-copy-ex {
312 | position: absolute;
313 | right: 0;
314 | top: 0;
315 | visibility: hidden;
316 | }
317 |
318 | .hasCopyButton:hover button.btn-copy-ex {
319 | visibility: visible;
320 | }
321 |
322 | /* headroom.js ------------------------ */
323 |
324 | .headroom {
325 | will-change: transform;
326 | transition: transform 200ms linear;
327 | }
328 | .headroom--pinned {
329 | transform: translateY(0%);
330 | }
331 | .headroom--unpinned {
332 | transform: translateY(-100%);
333 | }
334 |
335 | /* mark.js ----------------------------*/
336 |
337 | mark {
338 | background-color: rgba(255, 255, 51, 0.5);
339 | border-bottom: 2px solid rgba(255, 153, 51, 0.3);
340 | padding: 1px;
341 | }
342 |
343 | /* vertical spacing after htmlwidgets */
344 | .html-widget {
345 | margin-bottom: 10px;
346 | }
347 |
348 | /* fontawesome ------------------------ */
349 |
350 | .fab {
351 | font-family: "Font Awesome 5 Brands" !important;
352 | }
353 |
354 | /* don't display links in code chunks when printing */
355 | /* source: https://stackoverflow.com/a/10781533 */
356 | @media print {
357 | code a:link:after, code a:visited:after {
358 | content: "";
359 | }
360 | }
361 |
362 | /* Section anchors ---------------------------------
363 | Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
364 | */
365 |
366 | div.csl-bib-body { }
367 | div.csl-entry {
368 | clear: both;
369 | }
370 | .hanging-indent div.csl-entry {
371 | margin-left:2em;
372 | text-indent:-2em;
373 | }
374 | div.csl-left-margin {
375 | min-width:2em;
376 | float:left;
377 | }
378 | div.csl-right-inline {
379 | margin-left:2em;
380 | padding-left:1em;
381 | }
382 | div.csl-indent {
383 | margin-left: 2em;
384 | }
385 |
--------------------------------------------------------------------------------
/docs/reference/get_system_pricing_plans.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_pricing_plans feed. — get_system_pricing_plans • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | Grab the system_pricing_plans feed.
49 | Source: R/get_static_feeds.R
50 | get_system_pricing_plans.Rd
51 |
52 |
53 |
54 | get_system_pricing_plans grabs and tidies the system_pricing_plans
55 | feed for a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_pricing_plans(
61 | city,
62 | directory = NULL,
63 | file = "system_pricing_plans.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 |
115 |
116 |
117 |
118 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
--------------------------------------------------------------------------------
/docs/reference/gbfs.html:
--------------------------------------------------------------------------------
1 |
2 | Package: gbfs — gbfs • gbfs
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
53 |
54 |
55 | The gbfs package allows users to query tidy datasets about bikeshare
56 | programs around the world by supplying a set of functions to interface with
57 | .json feeds following the General Bikeshare Feed Specification, a standard
58 | data release format developed by the North American Bikeshare Association.
59 |
60 |
61 |
62 |
63 | Details
64 | The main function exported by this package is get_gbfs(), which
65 | grabs every feed released by a city. Alternatively, the user can just
66 | grab information on specific feeds (or groups of feeds).
67 | Each of the feeds described below can be queried with the get_suffix()
68 | function, where suffix is replaced with the name of the relevant feed.
69 | Although all of the feeds are livestreamed, only a few of the datasets
70 | change often:
71 | station_status:Supplies the number of available bikes and
73 | docks at each station as well as station availability
free_bike_status:Gives the coordinates and metadata on
77 | available bikes that are parked, but not at a station.
In this package, these two datasets are considered "dynamic", and can be
81 | specified as desired datasets by setting `feeds = "dynamic" in the
82 | main wrapper function in the package, get_gbfs.
83 | Much of the data supplied in this specification can be considered static.
84 | If you want to grab all of these for a given city, set feeds = "static"
85 | when calling get_gbfs. Static feeds include:
86 | system_information:Basic metadata about the bikeshare program
station_information:Information on the capacity and coordinates of stations
- Several optional feeds:
93 | system_hours, system_calendar,
94 | system_regions, system_pricing_plans, and system_alerts
98 |
99 | See also
100 | Useful links:
Report bugs at https://github.com/simonpcouch/gbfs/issues
103 |
104 |
110 |
111 |
112 |
115 |
116 |
117 |
118 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
--------------------------------------------------------------------------------
/docs/reference/get_system_hours.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_hours feed. — get_system_hours • gbfs
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
53 |
54 |
55 | get_system_hours grabs and tidies the system_hours
56 | feed for a given city. Metadata for this
57 | dataset can be found at:
58 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
59 |
60 |
61 |
62 | get_system_hours(
63 | city,
64 | directory = NULL,
65 | file = "system_hours.rds",
66 | output = NULL
67 | )
68 |
69 |
70 |
71 | Arguments
72 |
73 |
74 | - city
75 | A character string that can be matched to a gbfs feed. The recommended
76 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
77 | also attempt to match to the URL of an active .json feed or city name.
- directory
81 | Optional. Path to a folder (or folder to be
82 | created) where the feed will be saved.
- file
86 | Optional. The name of the file to be saved (if output
87 | is set to "save" or "both"), as a character string.
88 | Must end in ".rds".
- output
92 | Optional. The type of output method. If left as default, this
93 | argument is inferred from the directory argument. If
94 | output = "save", the object will be saved as an .rds object at
95 | # the given path. If output = "return", the output will be returned
96 | as a dataframe object. Setting output = "both" will do both.
99 |
100 | Value
101 | The output of this function depends on argument to output
102 | and directory. Either a saved .rds object generated from the current
103 | feed, a dataframe object, or both.
104 |
105 |
106 | See also
107 | [get_gbfs()] for a wrapper to call each of the get_feed
108 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
109 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
110 | are released by a given city.
111 |
112 |
113 |
114 | Examples
115 | # grab the system hours feed for portland, oregon
116 | get_system_hours(city =
117 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_hours.json",
118 | output = "return")
119 | #> data frame with 0 columns and 0 rows
120 |
121 |
122 |
123 |
124 |
127 |
128 |
129 |
130 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
--------------------------------------------------------------------------------
/docs/reference/get_system_alerts.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_alerts feed. — get_system_alerts • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
52 |
53 |
54 | get_system_alerts grabs and tidies the system_alerts feed for a given city.
55 | This feed informs users about changes to normal operation. Metadata for this
56 | dataset can be found at: https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_alerts(
61 | city,
62 | directory = NULL,
63 | file = "system_alerts.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 | Examples
113 | # grab the system alerts feed for portland, oregon
114 | get_system_alerts(city =
115 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_alerts.json",
116 | output = "return")
117 | #> data frame with 0 columns and 0 rows
118 |
119 |
120 |
121 |
122 |
125 |
126 |
127 |
128 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
--------------------------------------------------------------------------------
/docs/reference/get_system_calendar.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_calendar feed. — get_system_calendar • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | Grab the system_calendar feed.
49 | Source: R/get_static_feeds.R
50 | get_system_calendar.Rd
51 |
52 |
53 |
54 | get_system_calendar grabs and tidies the system_calendar feed
55 | for a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_calendar(
61 | city,
62 | directory = NULL,
63 | file = "system_calendar.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 | Examples
113 | # grab the system calendar feed for portland, oregon
114 | get_system_calendar(city =
115 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_calendar.json",
116 | output = "return")
117 | #> start_month end_day end_month start_day
118 | #> 1 1 31 12 1
119 |
120 |
121 |
122 |
123 |
124 |
127 |
128 |
129 |
130 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
--------------------------------------------------------------------------------
/docs/reference/get_which_gbfs_feeds.html:
--------------------------------------------------------------------------------
1 |
2 | Get dataframe of bikeshare feeds released by a city — get_which_gbfs_feeds • gbfs
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
49 | Get dataframe of bikeshare feeds released by a city
50 | Source: R/get_gbfs.R
51 | get_which_gbfs_feeds.Rd
52 |
53 |
54 |
55 | Of the different types of feeds supplied by the gbfs,
56 | some are required, some are conditionally required, and some are
57 | optional. This function grabs a list of each of the feeds supplied
58 | by a given city, as well as the URLs to access them.
59 |
60 |
61 |
62 | get_which_gbfs_feeds(city)
63 |
64 |
65 |
66 | Source
67 | North American Bikeshare Association, General Bikeshare Feed
68 | Specification https://github.com/MobilityData/gbfs/blob/master/gbfs.md
69 |
70 |
71 | Arguments
72 |
73 |
74 |
80 |
81 | Value
82 | A data.frame containing the feeds supplied by
83 | a city. . The `feed` column supplies the name of the relevant .json feeds,
84 | while the entries in the `URL` column supply the feeds themselves.
85 |
86 |
87 |
88 | Examples
89 | # grab all of the feeds released by portland
90 | get_which_gbfs_feeds(city = "biketown_pdx")
91 | #> url
92 | #> 1 https://gbfs.lyft.com/gbfs/2.3/pdx/gbfs.json
93 | #> 2 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_information.json
94 | #> 3 https://gbfs.lyft.com/gbfs/2.3/pdx/en/station_information.json
95 | #> 4 https://gbfs.lyft.com/gbfs/2.3/pdx/en/station_status.json
96 | #> 5 https://gbfs.lyft.com/gbfs/2.3/pdx/en/free_bike_status.json
97 | #> 6 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_hours.json
98 | #> 7 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_calendar.json
99 | #> 8 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_regions.json
100 | #> 9 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_pricing_plans.json
101 | #> 10 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_alerts.json
102 | #> 11 https://gbfs.lyft.com/gbfs/2.3/pdx/en/gbfs_versions.json
103 | #> 12 https://gbfs.lyft.com/gbfs/2.3/pdx/en/vehicle_types.json
104 | #> name
105 | #> 1 gbfs
106 | #> 2 system_information
107 | #> 3 station_information
108 | #> 4 station_status
109 | #> 5 free_bike_status
110 | #> 6 system_hours
111 | #> 7 system_calendar
112 | #> 8 system_regions
113 | #> 9 system_pricing_plans
114 | #> 10 system_alerts
115 | #> 11 gbfs_versions
116 | #> 12 vehicle_types
117 |
118 |
119 |
120 |
121 |
124 |
125 |
126 |
127 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
--------------------------------------------------------------------------------
/docs/reference/get_system_regions.html:
--------------------------------------------------------------------------------
1 |
2 | Grab the system_regions feed. — get_system_regions • gbfs
8 |
9 |
10 |
11 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | Grab the system_regions feed.
49 | Source: R/get_static_feeds.R
50 | get_system_regions.Rd
51 |
52 |
53 |
54 | get_system_regions grabs and tidies the system_regions feed for
55 | a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
57 |
58 |
59 |
60 | get_system_regions(
61 | city,
62 | directory = NULL,
63 | file = "system_regions.rds",
64 | output = NULL
65 | )
66 |
67 |
68 |
69 | Arguments
70 |
71 |
72 | - city
73 | A character string that can be matched to a gbfs feed. The recommended
74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will
75 | also attempt to match to the URL of an active .json feed or city name.
- directory
79 | Optional. Path to a folder (or folder to be
80 | created) where the feed will be saved.
- file
84 | Optional. The name of the file to be saved (if output
85 | is set to "save" or "both"), as a character string.
86 | Must end in ".rds".
- output
90 | Optional. The type of output method. If left as default, this
91 | argument is inferred from the directory argument. If
92 | output = "save", the object will be saved as an .rds object at
93 | # the given path. If output = "return", the output will be returned
94 | as a dataframe object. Setting output = "both" will do both.
97 |
98 | Value
99 | The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
102 |
103 |
104 | See also
105 | [get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
109 |
110 |
111 |
112 | Examples
113 | # we can grab the system regions feed for portland,
114 | # oregon in one of several ways! first, supply the `city`
115 | # argument as a URL, and save to file by leaving output
116 | # set to it's default. usually, we would supply a character
117 | # string (like "pdx", maybe,) for the `directory` argument
118 | # instead of `tempdir`.
119 | get_system_regions(city =
120 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_regions.json",
121 | directory = tempdir())
122 |
123 | # or, instead, just supply the name of
124 | # the city as a string and return the output
125 | # as a dataframe
126 | get_system_regions(city = "biketown_pdx",
127 | output = "return")
128 | #> name region_id
129 | #> 1 PDX PDX
130 |
131 |
132 |
133 |
136 |
137 |
138 |
139 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
--------------------------------------------------------------------------------
72 |
87 |
88 |
89 |
90 |
101 |
73 |
80 |
81 |
85 |
86 |
74 |
76 |
77 | Content not found. Please use links in the navbar.
78 |
79 | Page not found (404)
75 |
44 |
76 |
77 |
78 |
45 |
72 |
75 |
46 |
49 |
50 |
51 | Get table of all cities releasing GBFS feeds
47 | Source:R/get_gbfs.R
48 | get_gbfs_cities.Rd
52 |
54 |
55 | Get table of all cities releasing GBFS feeds
53 |
56 |
57 |
58 |
59 | get_gbfs_cities()
60 |
64 | Source
61 |North American Bikeshare Association, General Bikeshare Feed Specification 62 | https://raw.githubusercontent.com/MobilityData/gbfs/master/systems.csv
63 |
65 |
70 |
71 | Value
66 |A data.frame of all cities issuing GBFS feeds. The `Auto-Discovery URL`
67 | column supplies the relevant .json feeds, while the entries in the `URL` column
68 | take the user to the public-facing webpage of the programs.
44 |
66 |
67 |
68 |
69 |
45 |
60 |
61 |
64 |
65 |
46 |
48 |
49 | Contributor Code of Conduct
47 |
50 |
51 |
58 |
59 | As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
52 |We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
53 |Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
54 |Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct.
55 |Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
56 |This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html
57 |
44 |
111 |
112 |
113 |
45 |
106 |
107 |
110 |
46 |
48 |
49 | Reference
47 |
50 | All functions51 | 52 | |
53 | |
|---|---|
| 54 | 55 | | 56 |Package: gbfs |
57 |
| 58 | 59 | | 60 |Grab the free_bike_status feed. |
61 |
| 62 | 63 | | 64 |Grab bikeshare data |
65 |
| 66 | 67 | | 68 |Get table of all cities releasing GBFS feeds |
69 |
| 70 | 71 | | 72 |Grab the station_information feed. |
73 |
| 74 | 75 | | 76 |Grab the station_status feed. |
77 |
| 78 | 79 | | 80 |Grab the system_alerts feed. |
81 |
| 82 | 83 | | 84 |Grab the system_calendar feed. |
85 |
| 86 | 87 | | 88 |Grab the system_hours feed. |
89 |
| 90 | 91 | | 92 |Grab the system_information feed. |
93 |
| 94 | 95 | | 96 |Grab the system_pricing_plans feed. |
97 |
| 98 | 99 | | 100 |Grab the system_regions feed. |
101 |
| 102 | 103 | | 104 |Get dataframe of bikeshare feeds released by a city |
105 |
46 |
116 |
117 |
118 |
47 |
112 |
115 |
48 |
51 |
52 |
53 | Grab the system_pricing_plans feed.
49 | Source:R/get_static_feeds.R
50 | get_system_pricing_plans.Rd
54 |
58 |
59 | get_system_pricing_plans grabs and tidies the system_pricing_plans
55 | feed for a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
60 |
66 |
67 |
68 | get_system_pricing_plans(
61 | city,
62 | directory = NULL,
63 | file = "system_pricing_plans.rds",
64 | output = NULL
65 | )
69 |
97 | Arguments
70 | 71 | 72 |- city 73 |
A character string that can be matched to a gbfs feed. The recommended 74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will 75 | also attempt to match to the URL of an active .json feed or city name.
76 |
77 |
78 | - directory 79 |
Optional. Path to a folder (or folder to be 80 | created) where the feed will be saved.
81 |
82 |
83 | - file 84 |
Optional. The name of the file to be saved (if
output85 | is set to"save"or"both"), as a character string. 86 | Must end in".rds".
87 |
88 |
89 | - output 90 |
Optional. The type of output method. If left as default, this 91 | argument is inferred from the
directoryargument. If 92 |output = "save", the object will be saved as an .rds object at 93 | # the given path. Ifoutput = "return", the output will be returned 94 | as a dataframe object. Settingoutput = "both"will do both.
95 |
96 |
98 |
103 | Value
99 |The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
104 |
109 |
110 |
111 | See also
105 |[get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
47 |
116 |
117 |
118 |
48 |
53 |
54 |
112 |
115 |
55 |
60 |
61 |
62 | The gbfs package allows users to query tidy datasets about bikeshare
56 | programs around the world by supplying a set of functions to interface with
57 | .json feeds following the General Bikeshare Feed Specification, a standard
58 | data release format developed by the North American Bikeshare Association.
63 |
98 | Details
64 |The main function exported by this package is get_gbfs(), which
65 | grabs every feed released by a city. Alternatively, the user can just
66 | grab information on specific feeds (or groups of feeds).
Each of the feeds described below can be queried with the get_suffix()
68 | function, where suffix is replaced with the name of the relevant feed.
Although all of the feeds are livestreamed, only a few of the datasets 70 | change often:
71 |station_status:
72 | Supplies the number of available bikes and 73 | docks at each station as well as station availability
74 |
75 | free_bike_status:
76 | Gives the coordinates and metadata on 77 | available bikes that are parked, but not at a station.
78 |
79 |
80 |
In this package, these two datasets are considered "dynamic", and can be
81 | specified as desired datasets by setting `feeds = "dynamic" in the
82 | main wrapper function in the package, get_gbfs.
Much of the data supplied in this specification can be considered static.
84 | If you want to grab all of these for a given city, set feeds = "static"
85 | when calling get_gbfs. Static feeds include:
system_information:
87 | Basic metadata about the bikeshare program
88 |
89 | station_information:
90 | Information on the capacity and coordinates of stations
91 |
92 | - Several optional feeds: 93 |
system_hours,system_calendar, 94 |system_regions,system_pricing_plans, andsystem_alerts
95 |
96 |
97 |
99 |
103 |
104 |
110 |
111 | See also
100 |Useful links:
- 101 |
Report bugs at https://github.com/simonpcouch/gbfs/issues
102 |
47 |
128 |
129 |
130 |
48 |
53 |
54 |
124 |
127 |
55 |
60 |
61 | get_system_hours grabs and tidies the system_hours
56 | feed for a given city. Metadata for this
57 | dataset can be found at:
58 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
62 |
68 |
69 |
70 | get_system_hours(
63 | city,
64 | directory = NULL,
65 | file = "system_hours.rds",
66 | output = NULL
67 | )
71 |
99 | Arguments
72 | 73 | 74 |- city 75 |
A character string that can be matched to a gbfs feed. The recommended 76 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will 77 | also attempt to match to the URL of an active .json feed or city name.
78 |
79 |
80 | - directory 81 |
Optional. Path to a folder (or folder to be 82 | created) where the feed will be saved.
83 |
84 |
85 | - file 86 |
Optional. The name of the file to be saved (if
output87 | is set to"save"or"both"), as a character string. 88 | Must end in".rds".
89 |
90 |
91 | - output 92 |
Optional. The type of output method. If left as default, this 93 | argument is inferred from the
directoryargument. If 94 |output = "save", the object will be saved as an .rds object at 95 | # the given path. Ifoutput = "return", the output will be returned 96 | as a dataframe object. Settingoutput = "both"will do both.
97 |
98 |
100 |
105 | Value
101 |The output of this function depends on argument to output
102 | and directory. Either a saved .rds object generated from the current
103 | feed, a dataframe object, or both.
106 |
111 |
112 |
113 | See also
107 |[get_gbfs()] for a wrapper to call each of the get_feed
108 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
109 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
110 | are released by a given city.
114 |
122 |
123 | Examples
115 |# grab the system hours feed for portland, oregon
116 | get_system_hours(city =
117 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_hours.json",
118 | output = "return")
119 | #> data frame with 0 columns and 0 rows
120 |
121 |
46 |
126 |
127 |
128 |
47 |
52 |
53 |
122 |
125 |
54 |
58 |
59 | get_system_alerts grabs and tidies the system_alerts feed for a given city.
55 | This feed informs users about changes to normal operation. Metadata for this
56 | dataset can be found at: https://github.com/MobilityData/gbfs/blob/master/gbfs.md
60 |
66 |
67 |
68 | get_system_alerts(
61 | city,
62 | directory = NULL,
63 | file = "system_alerts.rds",
64 | output = NULL
65 | )
69 |
97 | Arguments
70 | 71 | 72 |- city 73 |
A character string that can be matched to a gbfs feed. The recommended 74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will 75 | also attempt to match to the URL of an active .json feed or city name.
76 |
77 |
78 | - directory 79 |
Optional. Path to a folder (or folder to be 80 | created) where the feed will be saved.
81 |
82 |
83 | - file 84 |
Optional. The name of the file to be saved (if
output85 | is set to"save"or"both"), as a character string. 86 | Must end in".rds".
87 |
88 |
89 | - output 90 |
Optional. The type of output method. If left as default, this 91 | argument is inferred from the
directoryargument. If 92 |output = "save", the object will be saved as an .rds object at 93 | # the given path. Ifoutput = "return", the output will be returned 94 | as a dataframe object. Settingoutput = "both"will do both.
95 |
96 |
98 |
103 | Value
99 |The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
104 |
109 |
110 |
111 | See also
105 |[get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
112 |
120 |
121 | Examples
113 |# grab the system alerts feed for portland, oregon
114 | get_system_alerts(city =
115 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_alerts.json",
116 | output = "return")
117 | #> data frame with 0 columns and 0 rows
118 |
119 |
46 |
128 |
129 |
130 |
47 |
124 |
127 |
48 |
51 |
52 |
53 | Grab the system_calendar feed.
49 | Source:R/get_static_feeds.R
50 | get_system_calendar.Rd
54 |
58 |
59 | get_system_calendar grabs and tidies the system_calendar feed
55 | for a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
60 |
66 |
67 |
68 | get_system_calendar(
61 | city,
62 | directory = NULL,
63 | file = "system_calendar.rds",
64 | output = NULL
65 | )
69 |
97 | Arguments
70 | 71 | 72 |- city 73 |
A character string that can be matched to a gbfs feed. The recommended 74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will 75 | also attempt to match to the URL of an active .json feed or city name.
76 |
77 |
78 | - directory 79 |
Optional. Path to a folder (or folder to be 80 | created) where the feed will be saved.
81 |
82 |
83 | - file 84 |
Optional. The name of the file to be saved (if
output85 | is set to"save"or"both"), as a character string. 86 | Must end in".rds".
87 |
88 |
89 | - output 90 |
Optional. The type of output method. If left as default, this 91 | argument is inferred from the
directoryargument. If 92 |output = "save", the object will be saved as an .rds object at 93 | # the given path. Ifoutput = "return", the output will be returned 94 | as a dataframe object. Settingoutput = "both"will do both.
95 |
96 |
98 |
103 | Value
99 |The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
104 |
109 |
110 |
111 | See also
105 |[get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
112 |
122 |
123 | Examples
113 |# grab the system calendar feed for portland, oregon
114 | get_system_calendar(city =
115 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_calendar.json",
116 | output = "return")
117 | #> start_month end_day end_month start_day
118 | #> 1 1 31 12 1
119 |
120 |
121 |
47 |
125 |
126 |
127 |
48 |
121 |
124 |
49 |
52 |
53 |
54 | Get dataframe of bikeshare feeds released by a city
50 | Source:R/get_gbfs.R
51 | get_which_gbfs_feeds.Rd
55 |
60 |
61 | Of the different types of feeds supplied by the gbfs, 56 | some are required, some are conditionally required, and some are 57 | optional. This function grabs a list of each of the feeds supplied 58 | by a given city, as well as the URLs to access them.
59 |
62 |
63 |
64 |
65 | get_which_gbfs_feeds(city)
66 |
70 | Source
67 |North American Bikeshare Association, General Bikeshare Feed 68 | Specification https://github.com/MobilityData/gbfs/blob/master/gbfs.md
69 |
71 |
80 | Arguments
72 | 73 | 74 |
81 |
86 |
87 | Value
82 |A data.frame containing the feeds supplied by
83 | a city. . The `feed` column supplies the name of the relevant .json feeds,
84 | while the entries in the `URL` column supply the feeds themselves.
88 |
119 |
120 | Examples
89 |# grab all of the feeds released by portland
90 | get_which_gbfs_feeds(city = "biketown_pdx")
91 | #> url
92 | #> 1 https://gbfs.lyft.com/gbfs/2.3/pdx/gbfs.json
93 | #> 2 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_information.json
94 | #> 3 https://gbfs.lyft.com/gbfs/2.3/pdx/en/station_information.json
95 | #> 4 https://gbfs.lyft.com/gbfs/2.3/pdx/en/station_status.json
96 | #> 5 https://gbfs.lyft.com/gbfs/2.3/pdx/en/free_bike_status.json
97 | #> 6 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_hours.json
98 | #> 7 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_calendar.json
99 | #> 8 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_regions.json
100 | #> 9 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_pricing_plans.json
101 | #> 10 https://gbfs.lyft.com/gbfs/2.3/pdx/en/system_alerts.json
102 | #> 11 https://gbfs.lyft.com/gbfs/2.3/pdx/en/gbfs_versions.json
103 | #> 12 https://gbfs.lyft.com/gbfs/2.3/pdx/en/vehicle_types.json
104 | #> name
105 | #> 1 gbfs
106 | #> 2 system_information
107 | #> 3 station_information
108 | #> 4 station_status
109 | #> 5 free_bike_status
110 | #> 6 system_hours
111 | #> 7 system_calendar
112 | #> 8 system_regions
113 | #> 9 system_pricing_plans
114 | #> 10 system_alerts
115 | #> 11 gbfs_versions
116 | #> 12 vehicle_types
117 |
118 |
46 |
137 |
138 |
139 |
47 |
133 |
136 |
48 |
51 |
52 |
53 | Grab the system_regions feed.
49 | Source:R/get_static_feeds.R
50 | get_system_regions.Rd
54 |
58 |
59 | get_system_regions grabs and tidies the system_regions feed for
55 | a given city. Metadata for this dataset can be found at:
56 | https://github.com/MobilityData/gbfs/blob/master/gbfs.md
60 |
66 |
67 |
68 | get_system_regions(
61 | city,
62 | directory = NULL,
63 | file = "system_regions.rds",
64 | output = NULL
65 | )
69 |
97 | Arguments
70 | 71 | 72 |- city 73 |
A character string that can be matched to a gbfs feed. The recommended 74 | argument is a system ID supplied in the output of [get_gbfs_cities()], but will 75 | also attempt to match to the URL of an active .json feed or city name.
76 |
77 |
78 | - directory 79 |
Optional. Path to a folder (or folder to be 80 | created) where the feed will be saved.
81 |
82 |
83 | - file 84 |
Optional. The name of the file to be saved (if
output85 | is set to"save"or"both"), as a character string. 86 | Must end in".rds".
87 |
88 |
89 | - output 90 |
Optional. The type of output method. If left as default, this 91 | argument is inferred from the
directoryargument. If 92 |output = "save", the object will be saved as an .rds object at 93 | # the given path. Ifoutput = "return", the output will be returned 94 | as a dataframe object. Settingoutput = "both"will do both.
95 |
96 |
98 |
103 | Value
99 |The output of this function depends on argument to output
100 | and directory. Either a saved .rds object generated from the current
101 | feed, a dataframe object, or both.
104 |
109 |
110 |
111 | See also
105 |[get_gbfs()] for a wrapper to call each of the get_feed
106 | functions, [get_gbfs_cities()] for a dataframe of cities releasing gbfs
107 | functions, and [get_which_gbfs_feeds()] for a dataframe of which feeds
108 | are released by a given city.
112 |
131 |
132 | Examples
113 |# we can grab the system regions feed for portland,
114 | # oregon in one of several ways! first, supply the `city`
115 | # argument as a URL, and save to file by leaving output
116 | # set to it's default. usually, we would supply a character
117 | # string (like "pdx", maybe,) for the `directory` argument
118 | # instead of `tempdir`.
119 | get_system_regions(city =
120 | "https://gbfs.lyft.com/gbfs/1.1/pdx/en/system_regions.json",
121 | directory = tempdir())
122 |
123 | # or, instead, just supply the name of
124 | # the city as a string and return the output
125 | # as a dataframe
126 | get_system_regions(city = "biketown_pdx",
127 | output = "return")
128 | #> name region_id
129 | #> 1 PDX PDX
130 |