In cccneto/Ibamam: Dataset for Environmental Fines by the Brazilian Institute of the Environment and Renewable Natural Resources

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

Ibamam

This package aims to provide the dataset for environmental fines and notices from the Brazilian Institute for the Environment and Renewable Natural Resources (IBAMA).

You can visit the IBAMA repository in the Brazilian Open Data Portal.

How to install?

This package can be installed via GitHub using the following code in R:

# install.packages("remotes")
remotes::install_github("cccneto/Ibamam")

How to use Ibamam?

The {Ibamam} package has one function available: get_dataset_ibamam(). This function returns a tibble, containing several columns described in the documentation of the function. This function has three arguments: dataset , uf and clean.

• dataset can receive one of the two values: distribuidas or arrecadadas. Use distribuidas to get data of the environmental fines applied by Ibama. Use arrecadadas to get data of the environmental fines collected by Ibama (which means that the fine has been paid).

• uf is the abreviation of the name of the states (two letters in lower case) that data will be obtained. The default value is "all", so all data from all the states of Brazil will be returned by default. Please notice that, If you use the default value, it might take several minutes to execute.

• clean is whether the dataset should be cleaned or not. If TRUE, the dataset will be cleaned. If FALSE, the returned dataset will be the original version, without modifications. Default is TRUE.

Examples on how to use this function:

library(Ibamam)

# get fines applied by IBAMA in Pará
fines_applied_Para <- get_dataset_ibamam(dataset = "distribuidas", uf = "PA")

dplyr::glimpse(fines_applied_Para)

# get fines collected by IBAMA in Pará
fines_collected_Para <- get_dataset_ibamam(dataset = "arrecadadas", uf = "PA")

dplyr::glimpse(fines_collected_Para)

If you want to get the data for the whole country (Brazil), do not write anything in the argument uf.

# get fines applied by IBAMA in Brazil
fines_applied_Brasil <- get_dataset_ibamam(dataset = "distribuidas")

# get fines collected by IBAMA in Brazil
fines_collected_Brasil <- get_dataset_ibamam(dataset = "arrecadadas")

If you want to get the data for more than one state, but not for the whole country, use a vector in the argument uf with the abbreviations of the name of the states.

# get fines applied by IBAMA in Southeast of Brazil
fines_applied_southeast <- get_dataset_ibamam(dataset = "distribuidas", uf = c("SP", "RJ", "ES", "MG"))

# get fines collected by IBAMA in Southeast of Brazil
fines_collected_southeast <- get_dataset_ibamam(dataset = "arrecadadas", uf = c("SP", "RJ", "ES", "MG"))

If you want to access the original data, without the cleaning steps, use the argument clean = FALSE. Example:

# get fines applied by IBAMA in São Paulo, without cleaning the dataset
untidy_fines_applied_SP <- get_dataset_ibamam(dataset = "distribuidas", uf = "SP", clean = FALSE)

dplyr::glimpse(untidy_fines_applied_SP)

Data cleaning

By default, the function get_dataset_ibamam() will use clean = TRUE and perform the following cleaning steps:

• Colunms dataAuto, ultimaAtualizacaoRelatorio, dataPagamento are transformed from class character to class date.

• Colunms tipoInfracao, tipoAuto, moeda, enquadramentoLegal are transformed from class character to class factor.

• Column enquadramentoJuridico is created from the cpfCnpj: if cpfCnpj has 14 characteres or less, is "CPF", else is "CNPJ".

• Column municipio is mutated into nomeMunicipio, and several cleanings is made in order to be possible to join with the names of municipalities in the package geobr.

• Join the dataset with the result of the package geobr, so the cleaned dataset has a column with the IBGE code of the municipality, called codigoMunicipio.

If you want to access the original data (without the cleaning steps), use the argument clean = FALSE.

How to cite Ibamam Package

"CRUZ NETO, Claudiano C., MILZ, Beatriz, MACEDO, Samuel (2021). Ibamam: Pacote para tratamento da Base de dados para multas e autuações ambientais aplicadas pelo Instituto Brasileiro do Meio Ambiente e dos Recursos Naturais Renováveis - Brasil. https://doi.org/10.5281/zenodo.4509344".

cccneto/Ibamam documentation built on Aug. 30, 2021, 8:55 p.m.