Skip to contents

Pull a NYC Open Data dataset from the NYC Open Data catalog

Source: R/nyc_pull_dataset.R
nyc_pull_dataset.Rd

Uses a dataset `key` or `uid` from `nyc_list_datasets()` to pull data from NYC Open Data.

Usage

nyc_pull_dataset(
  dataset,
  limit = 10000,
  filters = list(),
  date = NULL,
  from = NULL,
  to = NULL,
  date_field = NULL,
  where = NULL,
  order = NULL,
  timeout_sec = 30,
  clean_names = TRUE,
  coerce_types = TRUE
)

Arguments

dataset

A dataset key or UID from `nyc_list_datasets()`.

limit

Number of rows to retrieve (default = 10,000).

filters

Optional named list of filters. Supports vectors (translated to IN()).

date

Optional single date (matches all times that day) using `date_field`.

from

Optional start date (inclusive) using `date_field`.

to

Optional end date (exclusive) using `date_field`.

date_field

Optional date/datetime column to use with `date`, `from`, or `to`. Must be supplied when `date`, `from`, or `to` are used.

where

Optional raw SoQL WHERE clause. If `date`, `from`, or `to` are provided, their conditions are AND-ed with this.

order

Optional SoQL ORDER BY clause.

timeout_sec

Request timeout in seconds (default = 30).

clean_names

Logical; if TRUE, convert column names to snake_case (default = TRUE).

coerce_types

Logical; if TRUE, attempt light type coercion (default = TRUE).

Value

A tibble.

Details

Dataset keys are generated from dataset names using `janitor::make_clean_names()`. Because keys are derived from live catalog metadata, dataset UIDs are the more stable option.

Examples

if (interactive() && curl::has_internet()) {
  # Pull by key
  nyc_pull_dataset("311_service_requests", limit = 3)

  # Pull by UID
  nyc_pull_dataset("erm2-nwe9", limit = 3)

  # Filters
  nyc_pull_dataset("erm2-nwe9", limit = 3, filters = list(borough = "QUEENS"))

  # Date filtering
  nyc_pull_dataset(
    "erm2-nwe9",
    from = "2023-01-01",
    to = "2024-01-01",
    date_field = "created_date",
    limit = 100
  )
}