Retrieves a live catalog of NYC Open Data datasets from the NYC Open Data Portal catalog table (`5tqd-u88y`) and returns dataset metadata that can be used with [nyc_pull_dataset()].
Value
A tibble containing available NYC Open Data datasets. Important columns include:
- key
A human-readable dataset key generated from the dataset name.
- uid
The official Socrata dataset identifier used by NYC Open Data.
- name
The dataset name from the NYC Open Data catalog.
Additional metadata columns from the NYC Open Data catalog may also be returned.
Details
The returned tibble includes both the official Socrata dataset `uid` and a human-readable `key`. The `uid` is the stable identifier used by the NYC Open Data Portal and Socrata API, while the `key` is generated from the dataset name using [janitor::make_clean_names()] to make datasets easier to reference in R code, especially in classroom and reproducible research settings.
Most users will begin by calling `nyc_list_datasets()`, searching the returned catalog for a dataset of interest, and then passing either the `key` or `uid` to [nyc_pull_dataset()].
Examples
if (interactive() && curl::has_internet()) {
catalog <- nyc_list_datasets()
# View available datasets
catalog
# Search for 311-related datasets
catalog[grepl("311", catalog$name, ignore.case = TRUE), c("key", "uid", "name")]
}