Skip to contents

Retrieves a live catalog of Cincinnati Open Data datasets from the Cincinnati Open Data Portal catalog table (`CATALOG_DATASET_ID`) and returns dataset metadata that can be used with [cincinnati_pull_dataset()].

Usage

cincinnati_list_datasets()

Value

A tibble containing available Cincinnati 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 Cincinnati Open Data.

name

The dataset name from the Cincinnati Open Data catalog.

Additional metadata columns from the Cincinnati 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 Cincinnati 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 `cincinnati_list_datasets()`, searching the returned catalog for a dataset of interest, and then passing either the `key` or `uid` to [cincinnati_pull_dataset()].

Examples

if (interactive() && curl::has_internet()) {
  catalog <- cincinnati_list_datasets()

  # View available datasets
  catalog

  # Search for datasets containing a keyword
  catalog[
    grepl("Business", catalog$name, ignore.case = TRUE),
    c("key", "uid", "name")
  ]
}