Skip to contents

Load a fund's NAV data and optionally register its benchmark mapping

Source: R/fund_imp.R
load_fund.Rd

Imports a fund's NAV time series from an Excel file and stores it in the storage environment via store_timeseries(). Optionally, a benchmark column can also be imported, and a fund/index mapping is recorded in .fundsr$fund_index_map.

Usage

load_fund(
  ticker,
  file = NULL,
  data_sheet = 1,
  date_col = "^Date",
  nav_col = "^NAV",
  benchmark = NULL,
  benchmark_col = NULL,
  retrieve_benchmark = FALSE,
  date_order = "dmy"
)

Arguments

ticker

Fund ticker symbol. Used (in lower case) as the storage key and (in upper case) to derive the default filename.

file

Optional filename. If NULL (the default), it is inferred from ticker as described above.

data_sheet

Sheet index or name containing the NAV data. Defaults to 1.

date_col

Regular expression identifying the date column. Defaults to "^Date".

nav_col

Regular expression identifying the fund's NAV column. Defaults to "^NAV".

benchmark

Optional benchmark key that this fund should be associated with in the fund/index map. When retrieve_benchmark = TRUE, the same value is also used as the name under which the benchmark series is imported.

benchmark_col

Regular expression identifying the benchmark column in the Excel sheet. Only used when retrieve_benchmark = TRUE.

retrieve_benchmark

Logical; if TRUE, both benchmark and benchmark_col must be supplied and the benchmark column is imported alongside the fund.

date_order

Date parsing order passed to the importer. Defaults to "dmy".

Value

Invisibly returns NULL. The imported data are stored in .fundsr_storage under tolower(ticker). A fund/index mapping is recorded in .fundsr$fund_index_map when benchmark is supplied.

Details

If file is NULL, the function searches getOption("fundsr.data_dir") for exactly one of paste0(toupper(ticker), ".xlsx") or paste0(toupper(ticker), ".xls").

The function builds a column-translation mapping from the fund NAV column and, if requested, a benchmark column. It then calls read_timeseries_excel() to read the Excel file and store_timeseries() to cache the imported object under tolower(ticker). When benchmark is provided, a corresponding entry is added to .fundsr$fund_index_map to link the fund to its benchmark key.