| Title: | Open Welfare Data Brazil |
|---|---|
| Description: | Tools for collecting municipal-level data <http://www.transparencia.gov.br/swagger-ui.html> from several Brazilian governmental social programs. |
| Authors: | Joao Pedro Oliveira dos Santos [aut, cre]
|
| Maintainer: | Joao Pedro Oliveira dos Santos <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.0.1.0 |
| Built: | 2024-11-21 04:20:02 UTC |
| Source: | https://github.com/kimjoaoun/owdbr |
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.
getpbf_mun(IBGECODE, AAAA, MM = NULL, PAGE = 1, YEARLY = TRUE)getpbf_mun(IBGECODE, AAAA, MM = NULL, PAGE = 1, YEARLY = TRUE)
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. |
a tibble with the requested data, if there are more than one IBGECODE, returns all of them in the same tibble.
Reference date
Amount of money invested in the municipality.
Number of citizens wich are enrolled in the program in that moment
IBGE code of the municipality.
Name of the municipality.
Country of the municipality.
Abbreviation of name of the state in which the municipality is.
Full name of the state in wich the municipality is.
Type
Abbreviation of the program's name.
Full name of the program.
Joao Pedro Oliveira dos Santos, International Relations Institute, Pontifical Catholic University of Rio de Janeiro
## Not run: getpbf_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY = FALSE) ## End(Not run)## Not run: getpbf_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY = FALSE) ## End(Not run)
PETI (Child Labour Erradication Program) is a brazilian social welfare program that provides financial support for poor families. Its objective is to protect these families children from any type of work before the age of 16 years old, with that, the Federal Government expect them to keep going to school. 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.
getpeti_mun(IBGECODE, AAAA, MM, PAGE = 1, YEARLY = TRUE)getpeti_mun(IBGECODE, AAAA, MM, PAGE = 1, YEARLY = TRUE)
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. Default= 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. |
a tibble with the requested data, if there are more than one IBGECODE, returns all of them in the same tibble.
Reference date
Amount of money invested in the municipality.
Number of citizens wich are enrolled in the program in that moment
IBGE code of the municipality.
Name of the municipality.
Country of the municipality.
Abbreviation of name of the state in which the municipality is.
Full name of the state in wich the municipality is.
Type
Abbreviation of the program's name.
Full name of the program.
Joao Pedro Oliveira dos Santos, International Relations Institute, Pontifical Catholic University of Rio de Janeiro
## Not run: getpeti_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY=FALSE) ## End(Not run)## Not run: getpeti_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY=FALSE) ## End(Not run)
The program Seguro Defeso is a brazilian social welfare program that provides financial aid for fisherman and fisherwoman in periods in which this activity is prohibited by law due to the fish reproduction season. 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.
getsd_mun(IBGECODE, AAAA, MM = NULL, PAGE = 1, YEARLY = TRUE)getsd_mun(IBGECODE, AAAA, MM = NULL, PAGE = 1, YEARLY = TRUE)
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. |
a tibble with the requested data, if there are more than one IBGECODE, returns all of them in the same tibble.
Reference date
Amount of money invested in the municipality.
Number of citizens wich are enrolled in the program in that moment
IBGE code of the municipality.
Name of the municipality.
Country of the municipality.
Abbreviation of name of the state in which the municipality is.
Full name of the state in wich the municipality is.
Type
Abbreviation of the program's name.
Full name of the program.
Joao Pedro Oliveira dos Santos, International Relations Institute, Pontifical Catholic University of Rio de Janeiro
## Not run: getsd_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY = FALSE) ## End(Not run)## Not run: getsd_mun("3304557", AAAA = "2015", MM = "05", PAGE = 1, YEARLY = FALSE) ## End(Not run)
Download a tibble with all the IBGECODE from municipality of the desired State.
munlist(UF_Num)munlist(UF_Num)
UF_Num |
A number given by the IBGE (Brazilian Institute for Geography and Statistics) for each state, a list of them might be requested with the owdbr::uflist() function. |
a tibble with the requested data divided in 11 columns, if there are more than one IBGECODE, returns all of them in the same tibble.
Reference date
Amount of money invested in the municipality.
Number of citizens wich are enrolled in the program in that moment
IBGE code of the municipality.
Name of the municipality.
Country of the municipality.
Abbreviation of name of the state in which the municipality is.
Full name of the state in wich the municipality is.
Type
Abbreviation of the program's name.
Full name of the program.
Joao Pedro Oliveira dos Santos, International Relations Institute, Pontifical Catholic University of Rio de Janeiro
## Not run: munlist(11) ## End(Not run)## Not run: munlist(11) ## End(Not run)
Returns a tibble which contains the IBGE identification code of each one of all 23 UFs (Units of the Federation) in Brazil.
uflist(region = NA)uflist(region = NA)
region |
filter the UFs (Units of the Federation or States) by geographical region. If NA, all state are shown. According to the Brazilian Institute of Geography and Statistics, the country is divided in 5 regions: "Norte", "Nordeste", "Centro-Oeste", "Sul" and "Sudeste". |
a tibble with 3 columns.
The full name of the state.
The abbreviation of the state's name.
The identification number of the state.
Region of the country in which the State is located.
Joao Pedro Oliveira dos Santos, International Relations Institute, Pontifical Catholic University of Rio de Janeiro
Source: IBGE (Brazilian Institute of Geography and Statistics)
## Not run: uflist(reg = NA) # show all states of the country. uflist(region = "Sul") # only exhibit States in the 'Sul' region of the country. ## End(Not run)## Not run: uflist(reg = NA) # show all states of the country. uflist(region = "Sul") # only exhibit States in the 'Sul' region of the country. ## End(Not run)