Overview | Themes and fields | Retrieving data | Months not published yet | Checks behind the labels
Package: misocialr 0.4.0
André Leite
misocialr: Access the Brazilian 'MDS' Social Information Matrix ('MI Social') API from 'R'
'Tidyverse'-friendly interface to the 'MI Social' API of the Brazilian Ministry of Development and Social Assistance ('MDS', 'SAGI') <https://aplicacoes.mds.gov.br/sagi/servicos/misocial>. Retrieves monthly municipal series of the 'Cadastro Unico' (registered families and people by income bracket), the 'Bolsa Familia' programme (beneficiary families, benefits and transfers), the 'BPC' benefit, the social assistance network ('CRAS', 'CREAS' and other units), 'SUAS' funding, 'Bolsa Familia' conditionality monitoring and food security programmes as tidy long-format 'tibbles'.
Authors:
misocialr_0.4.0.tar.gz
misocialr_0.4.0.zip(r-4.7-any)misocialr_0.4.0.zip(r-4.6-any)
misocialr_0.4.0.tar.gz(r-4.7-any)misocialr_0.4.0.tar.gz(r-4.6-any)
misocialr_0.4.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
misocialr/json (API)
| # Install 'misocialr' in R: |
| install.packages('misocialr', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/strategicprojects/misocial/issues
Pkgdown/docs site:https://strategicprojects.github.io
Last updated from:f19524fcfb. Checks:6 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 123 | ||
| source / vignettes | OK | 233 | ||
| linux-release | OK | 133 | ||
| windows-devel | OK | 83 | ||
| windows-release | OK | 78 | ||
| wasm-release | OK | 106 |
Exports:ibge_code7mds_api_fieldsmds_bolsa_familiamds_bpc_suasmds_cadunicomds_clear_cachemds_datamds_drop_unpublishedmds_fieldsmds_localitiesmds_pbf_condicionalidadesmds_periodsmds_seguranca_alimentarmds_suas_financiamentomds_suas_redemds_themes
Dependencies:askpassclicurldplyrgenericsgluehttr2lifecyclemagrittropensslpillarpkgconfigpurrrR6rlangsystibbletidyselectutf8vctrswithr
Getting started with misocialr
Last update: 2026-10-31
Started: 2026-10-31
Real-world example: Bolsa Família in Pernambuco
Introduction | Step 1 — Find the fields | Step 2 — Retrieve three years of data | Step 3 — The state series | Step 4 — Value per family, municipality by municipality | Step 5 — Keep the provenance | Where to go next
Last update: 2026-10-31
Started: 2026-10-31
Understanding the MI Social API
Introduction | Documents: one municipality, one month | Field names and storage suffixes | The curated dictionary | Zero is not "missing" | How misocialr talks to the API | How the functions map to the API | Further reading
Last update: 2026-10-31
Started: 2026-10-31
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Convert 6-digit MDS municipality codes to 7-digit IBGE codes | ibge_code7 |
| List the fields published for one municipality | mds_api_fields |
| Bolsa Familia programme: beneficiary families, benefits and transfers | mds_bolsa_familia |
| BPC and social assistance network (CRAS, CREAS) | mds_bpc_suas |
| Cadastro Unico: registered families and people, by income bracket | mds_cadunico |
| Clear the session cache | mds_clear_cache |
| Fetch MI Social data | mds_data |
| Drop (or flag) months that were not published yet | mds_drop_unpublished |
| List curated fields | mds_fields |
| List municipalities available in the API | mds_localities |
| Bolsa Familia conditionalities: education and health follow-up | mds_pbf_condicionalidades |
| List the periods available for a field | mds_periods |
| Food and nutrition security: PAA, Fomento Rural and cisterns | mds_seguranca_alimentar |
| SUAS funding: FNAS transfers, account balances and IGD-M | mds_suas_financiamento |
| Social assistance network (CadSUAS) | mds_suas_rede |
| List the themes covered by the package | mds_themes |