melb_walk_fast: API using Socrata to Melbourne pedestrian data (per hour)

View source: R/soda.R

melb_walk_fastR Documentation

API using Socrata to Melbourne pedestrian data (per hour)

Description

API using Socrata to Melbourne pedestrian data (per hour)

Usage

melb_walk_fast(year = NULL, sensor = NULL, na.rm = FALSE, app_token = NULL)

Arguments

year

An integer or a vector of integers. By default, it's the current year.

sensor

Sensor names. By default, it pulls all the sensors. Use pull_sensor to see the available sensors.

na.rm

Logical. FALSE is the default suggesting to include NA in the dataset. TRUE removes the NAs.

app_token

Characters giving the application token. A limited number of requests can be made without an app token (NULL), but they are subject to much lower throttling limits than request that do include one. Sign up for an app token here.

Details

It provides the API using Socrata, where counts are uploaded on a monthly basis. The up-to-date data would be till the previous month. The data is sourced from Melbourne Open Data Portal. Please refer to Melbourne Open Data Portal for more details about the dataset and its policy.

Value

A tibble including these variables as follows:

  • Sensor: Sensor name

  • Date_Time: Date time when the pedestrian counts are recorded

  • Date: Date associated with Date_Time

  • Time: Time of day

  • Count: Hourly counts

See Also

melb_walk

Examples

## Not run: 
# Retrieve the year 2017
melb_walk_fast(year = 2017)

# Retrieve the year 2017 for Southern Cross Station
melb_walk_fast(year = 2017, sensor = "Southern Cross Station")

## End(Not run)

rwalkr documentation built on Nov. 16, 2022, 1:06 a.m.