get_dfp_docs: Get data from dfp docs

Description Usage Arguments Value Examples

View source: R/fct_get_dfp_docs.R

Description

Get data from dfp docs

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
get_dfp_docs(
  companies_cvm_codes,
  type_docs,
  type_format,
  first_year,
  last_year,
  clean_data,
  use_memoise,
  cache_folder
)

Arguments

companies_cvm_codes

Numeric CVM code of companies. IF set to NULL (default), will return data for all available companies.

type_docs

Type of financial documents. E.g. c('DRE', 'BPA'). Definitions: '*' = fetch all docs, 'BPA' = Assets (ativos), 'BPP' = Liabilities (passivo), 'DRE' = income statement (demonstrativo de resultados), 'DFC_MD' = cash flow by direct method (fluxo de caixa pelo metodo direto), 'DFC_MI' = cash flow by indirect method (fluxo de caixa pelo metodo indireto), 'DMPL' = statement of changes in equity (mutacoes do patrimonio liquido), 'DVA' = value added report (desmonstrativo de valor agregado)

type_format

Type of format of document (con = consolidated, ind = individual). Default = c('con', 'ind')

first_year

First year of selected data

last_year

Last year of selected data

clean_data

Clean data or return raw data? See read_dfp|itr_csv() for details

use_memoise

Use memoise caching? If no (default), the function will read all .csv files. If yes, will use package memoise for caching results (execution speed increases significantly)

cache_folder

Path of cache folder to keep memoise and zip files

Value

A dataframe

Examples

1
2
3
4
## Not run: 
# no example

## End(Not run)

msperlin/GetCVMData documentation built on Aug. 4, 2020, 1:19 a.m.