EikonNameCleaner: Convert Eikon formula's in human readable names

In GreenGrassBlueOcean/RefinitivR: Connect to Datastream and python Eikon api in r

Convert Eikon formula's in human readable names

Description

Convert Eikon formula's in human readable names

Usage

EikonNameCleaner(names, SpaceConvertor = ".")

Arguments

names	vector of data.frame column names
SpaceConvertor	converts spaces in variables name into one of the following characters ".", "," , "-", "_", default is "."

Details

The variables returned by the Eikon API are not always easily guessable upfront. There is no fixed way how variables are returned. EikonNameCleaner improves this by returning UpperCamel case variable names. It does however not turn capitalized words back into lowercase. So e.g. RDN_EXCHD2 will stay RDN_EXCHD2 and "Dividend yield" will return as "Dividend.Yield" (if SpaceConvertor is set as ".")

The parameter SpaceConvertor converts spaces into any of the following characters ".", "," , "-", "_". Setting SpaceConvertor to another value will cause no conversion of spaces in the variable names. Space Conversion is highly advisable due to the fact that otherwise issues could occur with accessing columnnames in the returned data.frame as an example "Dividend yield" will turn into "Dividend.Yield" with SpaceConvertor being set as "."

Value

a data.frame in which the Eikon formula's are replaced with the Eikon display Name which is the last part of the formula.

Examples

Refinitiv:::EikonNameCleaner(c("Instrument","Company Name","RDN_EXCHD2","Operating MIC"))

GreenGrassBlueOcean/RefinitivR documentation built on Feb. 1, 2024, 1:37 a.m.