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

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

Loads information the mines being explored legally in Brazil, including their location, status, product being mined and area in square meters etc. Survey is done at municipal and state level. The National Mining Agency (ANM) is responsible for this survey.
 
***
**Options:**

  1. **dataset**: `"sigmine_active"`

  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. **language**: you can choose between Portuguese `("pt")` and English `("eng")`
  
***

**Examples:** 
 
```{r eval=FALSE}
# Download treated data (raw_data = FALSE) in portuguese (language = "pt").
data <- load_sigmine(
  dataset = "sigmine_active",
  raw_data = FALSE,
  language = "pt"
)
```


