Skip to content

sidrar

0.6.0Package record

An Interface to IBGE's SIDRA API

2packages depend
23.1Kdownloads / year
94.3%test coverage
13/13flavors OK

Overview

About

Provides a flexible interface to discover, inspect, plan, and retrieve aggregate data from the Brazilian Institute of Geography and Statistics (IBGE) through its SIDRA application programming interfaces. SIDRA is IBGE's system for retrieving aggregate statistical data.

Changes in 0.6.0
  • Split relative or complete SIDRA values URLs with sidra_split(), preserving parameter order. Period selections all, first, last, and ranges can be frozen to the official period inventory before downloading values.
  • Added opt-in period batching with sidra_collect(batch_size = ...) and resumable local checkpoints with checkpoint = .... Completed batches have checksums and original access times; mismatched settings, schema drift, corrupted files, and concurrent writers fail explicitly. No implicit disk cache or change to get_sidra() is introduced.
  • info_sidra() can use official aggregate metadata and periods when the original descriptor returns a browser challenge. Its five legacy components are preserved; fields unavailable from the alternative source are disclosed instead of fabricated. Both-source failures retain the original error.
Show all changes in 0.6.0Hide the rest of the changes in 0.6.0
  • Expanded offline compatibility tests across monthly, quarterly, annual, and multiple-classification synthetic fixtures, including special symbols, UTF-8, leading-zero identifiers, and comparison by keys rather than row order.
  • Validate the complete alternative-response schema on every fallback path, including canonical queries at default precision. Reject out-of-selection codes and duplicate observation keys without altering identifiers or values. Missing explicitly requested members emit sidrar_incomplete_warning; sparse tables are not forced into a complete Cartesian product.
  • Honor Retry-After on HTTP 429 and 503 independently of quiet logging, including HTTP dates, while preserving the configured total attempt budget. The maximum accepted server-requested delay is configurable through options(sidrar.retry_after_max = 120), with a default of 60 seconds. Longer delays return an informative error with retry_after_max instead of retrying prematurely or waiting indefinitely.
  • Broadened the official aggregate API fallback to multiple territorial levels, complete and first-period selections, period ranges, and SIDRA URLs with dimensions in different orders. Dimension columns follow the original URL; observation order remains that returned by the alternative service.
  • Explicit decimal precision, including a single variable-specific /d/vID N selection, is accepted when numeric values already have the requested number of decimal places. Incompatible precision raises sidrar_fallback_precision_error rather than silently rounding values or inventing unavailable digits. Maximum precision remains unsupported by the alternative route.
  • Automatic classification discovery can use official aggregate metadata when SIDRA's table descriptor returns a Cloudflare challenge.
  • Recognized additional Cloudflare challenge pages containing a challenge title and the official challenge host, without requiring legacy HTML markers.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 1.8 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-09-30
  • ERROR12 OK, 1 ERROR2026-09-16
  • OK13 OK2026-08-04
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK14 OK2026-03-10
Advisories

none known

Documentation

Documentation signals are not tracked yet for this package.

Websitenot declared in DESCRIPTION

Downloads

23.1K
CRAN downloads in the past year
Rank #2,636 · ~63/day · ~1.9K/mo
sidrar
Daily download trend is not available in this view yet.
2.1K30 days
5.9K90 days
23.1K1 year
Compare downloads with other packages →
Also on255 r2u4 autocran

Repository

107Stars
16Forks
0Open issues
0Open PRs
9Releases
55Commits
2Commit identities
sidraapiibgerbrasilbrazil
55 commits · Last activity 2026-09-19 · +0.9% stars, 30d
Responsiveness
How these are sampled
PRs merged (all time)
25%
Median days to close, 50 most recently updated closed issues
39
Median days to close, 50 most recently updated closed PRs
74
PracticesBeta

7 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/rpradosiqueira/sidrar on 2026-10-21.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (1)
README.Rmd
CRAN release process (2)
cran-comments.mdCRAN-SUBMISSION
Lint, format, editor (1)
RStudio project
Show all practicesHide 1 practice
Git structural (1)
.gitattributes
How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies
5 external dependencies (excludes base and recommended)

Installing sidrar adds 8 packages (6 with compiled code, 3.0 MB of source tarballs). Heaviest: openssl 1.1 MB, jsonlite 1.0 MB, curl 714 KB.

Depends (1)
R >= 3.6.0
Imports (3)
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
2direct
0indirect
Imports 2
Depends, Imports or LinkingTo, most downloaded first

People & History

People (1)
Author, Maintainer since 0.1.1 (2017)
Releases (13)
  • 0.6.0Latest
    2026-09-28 · current release · diff ↗
  • 0.5.1
    2026-08-26 · diff ↗
  • 0.5.0
    2026-08-26 · diff ↗ ·
    added 11 exports
    sidra_cache_clear, sidra_cache_info, sidra_catalog, sidra_collect, sidra_locations, sidra_metadata, sidra_periods, sidra_plan, sidra_provenance, sidra_query, sidra_split
  • 0.3.0
    2026-07-23 · diff ↗
  • R
    R 4.6.0 released · 2026-04-24
  • R
    R 4.5.0 released · 2025-04-11
  • R
    R 4.4.0 released · 2024-04-24
  • R
    R 4.3.0 released · 2023-04-21
  • 0.2.9
    2022-07-13 · diff ↗
  • 0.2.8
    2022-06-03 · diff ↗
  • R
    R 4.2.0 released · 2022-04-22
  • 0.2.7
    2022-01-05 · diff ↗
  • 0.2.6
    2021-08-02 · diff ↗
  • R
    R 4.1.0 released · 2021-05-18
  • R
    R 4.0.0 released · 2020-04-24
  • 0.2.5
    2020-01-27 · diff ↗
Show 7 earlier eventsHide 7 earlier events

Package metadata

First published
2017-04-23
Total releases
13 / 9 yrs
License
GPL-3 OSI
Download size
111 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("sidrar")
Prado Siqueira, R. (2026). sidrar: An Interface to IBGE's SIDRA API (Version 0.6.0) [Computer software]. https://doi.org/10.32614/CRAN.package.sidrar

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for sidrar version 0.6.0 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy