  <!-- badges: start -->
  [![R-CMD-check](https://github.com/msperlin/GetDFPData2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/msperlin/GetDFPData2/actions/workflows/R-CMD-check.yaml)
  <!-- badges: end -->

`GetDFPData2` is the second and backwards incompatible version of `GetDPFData`,  a R package for downloading annual financial reports from B3, the Brazilian financial exchange. Unlike its first iteration, `GetDFPData2` imports data using a  database of csv files from [CVM](https://dados.cvm.gov.br/dados/CIA_ABERTA/), which makes it execute much faster than its predecessor. However, the output is slightly different.

If you're looking for historical data from DFP, a set of compiled datasets are available in my [website](https://msperlin.com/data/).


# Installation

```r
# available in cran (stable)
install.packages('GetDFPData2')

# github (dev version)
devtools::install_github('msperlin/GetDFPData2')
```

# Examples of Usage

## Information about available companies

```r
library(GetDFPData2)

# information about companies
df_info <- get_info_companies(tempdir())
print(df_info )
```

## Searching for companies

```{r}
search_company('grendene', cache_folder = tempdir())
```

## Downloading Financial Reports

```r
library(GetDFPData2)

# downloading DFP data
l_dfp <- get_dfp_data(companies_cvm_codes = 19615, 
                      use_memoise = FALSE,
                      clean_data = TRUE,
                      cache_folder = tempdir(), # use local folder in live code
                      type_docs = c('DRE'), 
                      type_format = 'con',
                      first_year = 2019, 
                      last_year = 2020)

str(l_dfp)
```

