load_custom_data: Load custom data from inst/extdata or a user-specified path

In olr: Optimal Linear Regression

Load custom data from inst/extdata or a user-specified path

Description

This function loads custom data from the inst/extdata directory of the package or a designated path provided by the user.

Usage

load_custom_data(
  data = "crudeoildata.csv",
  custom_path = NULL,
  exclude_first_column = FALSE
)

Arguments

data	The name of the data file to load (default: "crudeoildata.csv").
custom_path	An optional custom file path. If provided, it overrides the default file path.
exclude_first_column	Logical value indicating whether to exclude the first column from the loaded data (default: FALSE).

Format

A data frame with 55 weekly observations and 19 columns, including headers. The first column represents the date in the format MM/DD/YYYY, while all other columns display weekly percentage changes with five-decimal precision.

Value

A data frame containing the loaded data.

Source

Example dataset compiled from the following public sources: - Crude oil supply/demand metrics (FieldProduction, RefinerNetInput, OperableCapacity, Imports, StocksExcludingSPR): https://www.eia.gov - API gravity and Rig Count: Extracted from industry reports - S&P 500 Index (SPX): https://fred.stlouisfed.org/series/SP500 - CFTC positioning data (NonCommercialLong, CommercialShort, OpenInterest, etc.): https://www.cftc.gov (NYMEX short format) - TotalLong and TotalShort = NonCommercial (L/S) + Spread (L/S) + Commercial (L/S)

Examples

## Not run: 
# Load custom data with default options
df <- load_custom_data()

# Load data from a custom file path and exclude the first column (e.g., a Date column)
df <- load_custom_data(
  data = "crudeoildata.csv",
  custom_path = "path/to/custom/crudeoildata.csv",
  exclude_first_column = TRUE
)

# Load default custom data and exclude the first column
df <- load_custom_data(exclude_first_column = TRUE)

## End(Not run)

olr documentation built on June 8, 2025, 1:33 p.m.