get_dataset: Get Dataset

In realestatebr: Import Brazilian Real Estate Data into R

Get Dataset

Description

Unified interface for accessing all realestatebr datasets. Resolves data from the package's GitHub release assets when possible (fast, pre-processed, updated weekly by CI) and falls back to a fresh download from the original source. Repeated calls within one R session are served from an in-memory memo to avoid redundant network traffic.

Usage

get_dataset(
  name,
  table = NULL,
  source = "auto",
  date_start = NULL,
  date_end = NULL,
  ...
)

Arguments

name	Character. Dataset name (see list_datasets for options).
table	Character. Specific table within a multi-table dataset. See get_dataset_info for available tables per dataset.
source	Character. Data source preference: "auto" Use the in-session memo if available, otherwise GitHub releases, otherwise fresh download (default). "github" Pre-processed asset from the package's GitHub release. "fresh" Fresh download from the original source. Use clear_session_cache to drop the in-session memo.
date_start	Date. Start date for time series filtering (where applicable).
date_end	Date. End date for time series filtering (where applicable).
...	Additional arguments passed to internal dataset functions.

Value

A tibble or named list, depending on the dataset. Use get_dataset_info to inspect the expected structure.

See Also

list_datasets for available datasets, get_dataset_info for dataset details, clear_session_cache to drop the in-session memo.

Examples

abecip_data <- get_dataset("abecip")

sbpe_data <- get_dataset("abecip", table = "sbpe")

bcb_recent <- get_dataset("bcb_series", date_start = as.Date("2020-01-01"))

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