list_datasets: List Available Datasets

View source: R/list_datasets.R

list_datasetsR Documentation

List Available Datasets

Description

Returns a tibble describing all datasets available in the realestatebr package. Optionally filter by category, source organization, or geographic coverage.

Usage

list_datasets(category = NULL, source = NULL, geography = NULL)

Arguments

category

Optional character. Keyword matched against the dataset description (e.g., "indicators", "prices", "credit").

source

Optional character. Filter by data source organization (e.g., "BCB", "FIPE", "ABRAINC").

geography

Optional character. Filter by geographic coverage (e.g., "Brazil", "São Paulo").

Value

A tibble with one row per dataset and the following columns:

name

Dataset identifier used with get_dataset.

title

English dataset name.

title_pt

Portuguese dataset name.

description

Brief description.

source

Data source organization.

geography

Geographic coverage.

frequency

Update frequency.

coverage

Time period covered.

available_tables

Comma-separated table names for multi-table datasets.

See Also

get_dataset for retrieving data, get_dataset_info for detailed metadata on a single dataset.

Examples

list_datasets()

list_datasets(source = "BCB")


realestatebr documentation built on June 5, 2026, 5:07 p.m.