ls_underlyings {FinancialInstrument}

show names of underlyings

Description

shows names that are stored in the underlying_id slot of derivative instruments

Usage

ls_underlyings(pattern = NULL, match = TRUE)

Arguments

pattern

an optional regular expression. Only names matching ‘pattern’ are returned.

match

require exact match?

Details

first calls ls_derivatives, then looks for unique underlying_ids. If no derivatives have been defined, nothing will be returned.

Value

chr vector of names of unique underlying_ids

Author(s)

Garrett See

See Also

ls_instruments_by, ls_derivatives, ls_options, ls_futures

Examples

## Not run: 
ls_underlyings()

## End(Not run)