FINANCIAL.TIMESTAMP: Access parameters from a configuration file

In 2DegreesInvesting/r2dii.utils: General Utility Tools

Access parameters from a configuration file

Description

Access parameters from a configuration file

Usage

FINANCIAL.TIMESTAMP(file = get_config())

timestamps_datastore_export(file = get_config())

FINANCIAL.TIMESTAMP(file = get_config())

ALD.TIMESTAMP(file = get_config())

DATASTORE.TIMESTAMP(file = get_config())

DATAPREP.TIMESTAMP(file = get_config())

START.YEAR(file = get_config())

TIME.HORIZON(file = get_config())

RISK.YEAR(file = get_config())

ADDITIONAL.YEAR(file = get_config())

TECH.LIST(file = get_config())

TECH.EXCLUDE(file = get_config())

SECTOR.LIST(file = get_config())

OTHER.SECTOR.LIST(file = get_config())

SCENARIO.SOURCES.LIST(file = get_config())

IEA.SCENARIO.LIST(file = get_config())

WEB.REGION.LIST(file = get_config())

SCENARIO.GEOGRAPHIES.LIST(file = get_config())

EQUITY.MARKET.LIST(file = get_config())

GLOBAL.AGGREGATE.SECTOR.LIST(file = get_config())

GLOBAL.AGGREGATE.SCENARIO.SOURCES.LIST(file = get_config())

CREATE.META.PORTFOLIO(file = get_config())

META.INVESTOR.NAME(file = get_config())

META.PORTFOLIO.NAME(file = get_config())

HasBV(file = get_config())

HasRISK(file = get_config())

HasMAP(file = get_config())

HasSB(file = get_config())

inc_metaportfolio(file = get_config())

inc_project_metaportfolio(file = get_config())

allowable_asset_list(file = get_config())

Arguments

file	A string giving a path to a configuration file.

Value

The value of the requested field. It's base time depends on the field.

See Also

get_param

Other functions to get specific 2dii configuration parameters: get_param()

Examples

# Using the default configuration file that comes with the package
FINANCIAL.TIMESTAMP()

# Using your configuration file
path_to_your_config_file <- example_config("config-toy.yml")

# Passing your configuration file via the `file` argument
FINANCIAL.TIMESTAMP(file = path_to_your_config_file)

# The default remains the same
FINANCIAL.TIMESTAMP()
ALD.TIMESTAMP()

# Setting the path to your configuration file globally
old_options <- options(r2dii_config = path_to_your_config_file)
# The default configuration file has now changed
FINANCIAL.TIMESTAMP()
ALD.TIMESTAMP()

# Reset options to cleanup
options(old_options)
timestamps_datastore_export()
FINANCIAL.TIMESTAMP()
DATASTORE.TIMESTAMP()
DATAPREP.TIMESTAMP()
START.YEAR()
TIME.HORIZON()
RISK.YEAR()
ADDITIONAL.YEAR()
TECH.LIST()
TECH.EXCLUDE()
SECTOR.LIST()
OTHER.SECTOR.LIST()
SCENARIO.SOURCES.LIST()
IEA.SCENARIO.LIST()
WEB.REGION.LIST()
SCENARIO.GEOGRAPHIES.LIST()
EQUITY.MARKET.LIST()
GLOBAL.AGGREGATE.SECTOR.LIST()
GLOBAL.AGGREGATE.SCENARIO.SOURCES.LIST()
CREATE.META.PORTFOLIO()
META.INVESTOR.NAME()
META.PORTFOLIO.NAME()
HasBV()
HasRISK()
HasMAP()
HasSB()
config <- create_config("
  default:
    ComparisonBenchmarks:
      CreateMetaPortfolio: a_value
")
inc_metaportfolio(config)
config <- create_config("
  default:
    ComparisonBenchmarks:
      CreateProjectMetaPortfolio: a_value
")
inc_project_metaportfolio(config)
config <- create_config("
  default:
    Lists:
      AssetTypes: a_value
")
allowable_asset_list(config)

2DegreesInvesting/r2dii.utils documentation built on March 31, 2022, 11:20 p.m.