---
title: "IBAMA"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{IBAMA}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

The dataset is originally from the Brazilian Institute of Environment and Renewable  Natural Resources (Ibama), documenting environmental embargoes and fines at the individual level from 2005 to the present day. In addition, it is possible to download distributed and collected fines from 1994 until the present day.

The function returns either the raw data or a data frame with aggregates considering, for each time-location period, counts for total the number of infractions, infractions that already went to trial, and number of unique perpetrators of infractions. There are also two data frames regarding distributed and collected fines across municipalities

***
**Options:**

  1. **dataset**: there are three possible choices.
      * `"embargoed_areas"`: embargoed areas
      * `"distributed_fines"`: fines that have not been paid by individuals or corporations
      * `"collected_fines"`: fines that have been paid by individuals or corporations

  2. **raw_data**: there are two options:
      * `TRUE`: if you want the data as it is originally.
      * `FALSE`: if you want the treated version of the data. 
  
  3. **states**: specifies for which states to download the data. It is "all" by default, but can be a single state such as `"AC"` or any vector such as `c("AC", "AM")`. Does not apply to the `"embargoed_areas"` dataset.

  4. **language**: you can choose between Portuguese `("pt")` and English `("eng")`
  
***

**Examples:**

```{r, eval = FALSE}
library(datazoom.amazonia)

# Download treated embargoes data (raw_data = FALSE) in english (language = "eng")
data <- load_ibama(
  dataset = "embargoed_areas", raw_data = FALSE,
  language = "eng"
)

# Download treated collected fines data from "BA"
data <- load_ibama(
  dataset = "collected_fines", raw_data = FALSE,
  states = "BA", language = "pt"
)
```