info_sidra: List the parameters of a SIDRA table

In sidrar: An Interface to IBGE's SIDRA API

List the parameters of a SIDRA table

Description

Uses the official JSON table descriptor to return variables, periods, classifications, categories, and geographic levels available in a table.

Usage

info_sidra(x, wb = FALSE)

Arguments

x	A numeric SIDRA table code.
wb	Logical. When TRUE, open the official HTML descriptor in the default browser. When FALSE, return structured metadata.

Details

Metadata is requested live from the official descriptor endpoint and is not cached by the package. The timeout and retry options described in get_sidra() also apply. If the descriptor returns a recognized Cloudflare challenge, the official aggregate API v3 metadata and periods are used unless options(sidrar.fallback = FALSE) is set. This alternative preserves the five legacy components but cannot supply descriptor-specific geographic names, active-unit counts, or variable availability exceptions. Geographic descriptions label the unavailable counts explicitly; no zero counts or availability ranges are inferred. The sidrar_metadata attribute records the alternative source URLs and unavailable fields. Periods are listed as codes, without assuming continuous coverage. Missing variable units are recorded in this attribute and omitted from their descriptions.

Value

When wb = FALSE, a list with components table, period, variable, classific_category, and geo. When wb = TRUE, the descriptor URL is returned invisibly after the browser is opened.

Author(s)

Renato Prado Siqueira [e-mail]

See Also

get_sidra() and sidra_metadata()

Examples

## Not run: 
info_sidra(7060)
info_sidra(7060, wb = TRUE)

## End(Not run)

sidrar documentation built on Sept. 28, 2026, 5:07 p.m.