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

Description Usage Arguments Value Examples

View source: R/gitrd_get_info_companies.R

Description

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

Usage

1
gitrd.get.info.companies(type.data = "companies_files")

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.

Value

A dataframe with several information about Bovespa companies

Examples

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

## End(Not run)

msperlin/GetITRData documentation built on March 23, 2020, 6:43 p.m.