getpbf_mun {owdbr}

Collects municipal level data from the program BOLSA FAMILIA database.

Description

The program BOLSA FAMILIA is a brazilian social welfare program that provides financial aid for poor families. This function collects municipal level data from the program, some data like the number of citizens in a municipality which are enrolled in the program, and the total amount of money invested by the program in that city.

Usage

getpbf_mun(IBGECODE, AAAA, MM = NULL, PAGE = 1, YEARLY = TRUE)

Arguments

IBGECODE

IBGE unique identifier of the municipality which you want the data. The list of municipalities and its codes might be requested with the function owdbr::munlist()

AAAA

Year of the data (AAAA format)

MM

Month of the data (MM format)

PAGE

Request's page. In normal situations: page=1.

YEARLY

If True, it is not needed to fill the MM param, the package will request the data for the entire year (AAAA). Default= TRUE.

Value

a tibble with the requested data, if there are more than one IBGECODE, returns all of them in the same tibble.

dataReferencia

Reference date

valor

Amount of money invested in the municipality.

quantidadeBeneficiados

Number of citizens wich are enrolled in the program in that moment

municipio.codigoIBGE

IBGE code of the municipality.

municipio.nomeIBGE

Name of the municipality.

municipio.pais

Country of the municipality.

municipio.uf.sigla

Abbreviation of name of the state in which the municipality is.

municipio.uf.nome

Full name of the state in wich the municipality is.

tipo.id

Type

tipo.descricao

Abbreviation of the program's name.

tipo.descricaoDetalhada

Full name of the program.

Author(s)

Joao Pedro Oliveira dos Santos, International Relations Institute, Pontifical Catholic University of Rio de Janeiro

Examples

## Not run: 
getpbf_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY = FALSE)

## End(Not run)