gdfpd.get.info.companies: Reads up to date information about Bovespa companies from a...

Description Usage Arguments Value Examples

View source: R/gdfpd_get_info_companies.R

Description

A csv file with information about available companies, file links and time periods is read from github. This file is manually updated by the author. When run for the first time in a R session, a .RDATA file containing the output of the function is saved for caching.

Usage

1
2
3
4
gdfpd.get.info.companies(
  type.data = "companies_files",
  cache.folder = "DFP Cache Folder"
)

Arguments

type.data

A string that sets the type of information to be returned ('companies' or 'companies_files'). If 'companies', it will return a dataframe with several information about companies, but without download links.

cache.folder

Folder to cache (save) all processed information. Default = file.path(getwd(),'DFP Cache Folder')

Value

A dataframe with several information about Bovespa companies

Examples

1
2
3
4
5
## Not run:  # keep cran check fast
df.info <- gdfpd.get.info.companies()
str(df.info)

## End(Not run)

GetDFPData documentation built on April 1, 2021, 5:07 p.m.