Skip to contents

Cadastro Unico: registered families and people, by income bracket

Source: R/dados.R
mds_cadunico.Rd

Shortcut for mds_data() with the curated Cadastro Unico fields (mds_fields("cadunico")).

Usage

mds_cadunico(periods = NULL, localities = "BR", fields = NULL)

Arguments

periods

Periods to fetch:

  • NULL (default): the last 12 months up to the current month;

  • a negative number -n: the last n months up to the current month;

  • years (2024) and/or months as YYYYMM (202401, "202401").

localities

"BR" (all of Brazil), state abbreviations ("PE") or 2-digit state codes (26), and/or 6- or 7-digit IBGE municipality codes (2611606), in any combination. Default "BR".

fields

Fields to fetch. NULL (default) fetches every curated field of the theme.

Value

A tibble in the format of mds_data().

Examples

if (FALSE) { # interactive()
mds_cadunico(periods = 2025, localities = "PE")
}