FinancialInstrument: Financial Instrument Model Infrastructure for R

Infrastructure for defining meta-data and relationships for financial instruments.

Install the latest version of this package by entering the following in R:
AuthorPeter Carl, Brian G. Peterson, Garrett See
Date of publication2014-12-16 00:49:25
MaintainerGarrett See <>

View on CRAN

Man pages Add a source to the field of an 'instrument'

add.identifier: Add an identifier to an 'instrument'

all.equal.instrument: instrument all.equal method

buildHierarchy: Construct a hierarchy of instruments useful for aggregation

buildRatio: construct price ratios of 2 instruments

build_series_symbols: construct a series of symbols based on root symbol and suffix...

buildSpread: Construct a price/level series for pre-defined multi-leg...

build_spread_symbols: build symbols for exchange guaranteed (calendar) spreads

C2M: Month-to-Code and Code-to-Month

CompareInstrumentFiles: Compare Instrument Files

currencies: currency metadata to be used by 'load.instruments'

exchange_rate: constructor for spot exchange rate instruments

expires: extract the correct expires value from an 'instrument'

expires.character: character expires extraction method

expires.instrument: instrument expires extraction method

expires.spread: spread expires extraction method

expires.xts: xts expires extraction method

FinancialInstrument-package: Construct, manage and store contract specifications for...

FindCommonInstrumentAttributes: Find attributes that more than one instrument have in common

find.instrument: Find the primary_ids of instruments that contain certain...

fn_SpreadBuilder: Calculate prices of a spread from 2 instruments.

format_id: format an id

formatSpreadPrice: format the price of a synthetic instrument

getInstrument: Primary accessor function for getting objects of class...

get_rate: get an exchange rate series

getSymbols.FI: getSymbols method for loading data from split files

instrument: instrument class constructors

instrument_attr: Add or change an attribute of an instrument Create an instrument based on name alone

instrument.table: Create data.frame with attributes of all instruments

is.currency: class test for object supposedly of type 'currency' check each element of a character vector to see if it is...

is.instrument: class test for object supposedly of type 'instrument' check each element of a character vector to see if it is...

load.instruments: load instrument metadata into the .instrument environment

ls_by_currency: shows or removes instruments of given currency...

ls_by_expiry: list or remove instruments by expiration date

ls_expiries: show unique expiration dates of instruments

ls_instruments: List or Remove instrument objects

ls_instruments_by: Subset names of instruments

ls_strikes: show strike prices of defined options

ls_underlyings: show names of underlyings

make_spread_id: Construct a primary_id for a 'spread' 'instrument' from the...

month_cycle2numeric: coerce month_cycle to a numeric vector

next.future_id: Get the primary_id of the next-to-expire (previously...

Notionalize: Convert price series to/from notional value constructor for series of options using yahoo data

parse_id: Parse a primary_id

parse_suffix: parse a suffix_id id.list class print method

print.instrument: instrument class print method

print.suffix.list: suffix.list class print method

redenominate: Redenominate (change the base of) an instrument

root_contracts: future metadata to be used by 'load.instruments'

saveInstruments: Save and Load all instrument definitions

saveSymbols.days: Save data to disk

series_instrument: Constructors for series contracts

setSymbolLookup.FI: set quantmod-style SymbolLookup for instruments

sort_ids: sort primary_ids of instruments

sort.instrument: instrument class sort method

synthetic.instrument: synthetic instrument constructors

Tick2Sec: Convert tick data to one-second data

to_daily: Extract a single row from each day in an xts object

update_instruments.instrument: Update instruments with metadata from another instrument.

update_instruments.iShares: update iShares and SPDR ETF metadata

update_instruments.masterDATA: Update instrument metadata for ETFs

update_instruments.morningstar: Update instrument metadata for ETFs updates instrument metadata with data from yahoo

volep: generate endpoints for volume bars

Functions Man page
add.identifier Man page
all.equal.instrument Man page
alltick2sec Man page
bond Man page
bond_series Man page
buildBasket Man page
buildHierarchy Man page
buildRatio Man page
build_series_symbols Man page
buildSpread Man page
build_spread_symbols Man page
butterfly Man page
C2M Man page
CompareInstrumentFiles Man page
currencies Man page
currency Man page
Denotionalize Man page
exchange_rate Man page
expires Man page
expires.character Man page
expires.instrument Man page
expires.spread Man page
expires.xts Man page
FinancialInstrument Man page
FinancialInstrument-package Man page
FindCommonInstrumentAttributes Man page
find.instrument Man page
fn_SpreadBuilder Man page
format_id Man page
formatSpreadPrice Man page
fund Man page
future Man page
future_series Man page
getInstrument Man page
.get_rate Man page
getSymbols.FI Man page
guaranteed_spread Man page
ICS Man page
ICS_root Man page
instrument Man page
instrument_attr Man page Man page
instrument.table Man page
is.currency Man page Man page
is.instrument Man page Man page
load.instruments Man page
loadInstruments Man page
ls_AUD Man page
ls_bonds Man page
ls_by_currency Man page
ls_by_expiry Man page
ls_CAD Man page
ls_calls Man page
ls_CHF Man page
ls_currencies Man page
ls_derivatives Man page
ls_EUR Man page
ls_exchange_rates Man page
ls_expires Man page
ls_expiries Man page
ls_funds Man page
ls_futures Man page
ls_future_series Man page
ls_FX Man page
ls_GBP Man page
ls_guaranteed_spreads Man page
ls_HKD Man page
ls_ICS Man page
ls_ICS_roots Man page
ls_instruments Man page
ls_instruments_by Man page
ls_JPY Man page
ls_non_currencies Man page
ls_non_derivatives Man page
ls_NZD Man page
ls_options Man page
ls_option_series Man page
ls_puts Man page
ls_SEK Man page
ls_spreads Man page
ls_stocks Man page
ls_strikes Man page
ls_synthetics Man page
ls_underlyings Man page
ls_USD Man page
M2C Man page
make_spread_id Man page
MC2N Man page
month_cycle2numeric Man page
next.future_id Man page
Notionalize Man page
option Man page
option_series Man page Man page
parse_id Man page
parse_suffix Man page
prev.future_id Man page Man page
print.instrument Man page
print.suffix.list Man page
redenominate Man page
reloadInstruments Man page
rm_bonds Man page
rm_by_currency Man page
rm_by_expiry Man page
rm_currencies Man page
rm_derivatives Man page
rm_exchange_rates Man page
rm_funds Man page
rm_futures Man page
rm_future_series Man page
rm_FX Man page
rm_instruments Man page
rm_non_derivatives Man page
rm_options Man page
rm_option_series Man page
rm_spreads Man page
rm_stocks Man page
rm_synthetics Man page
root_contracts Man page
saveInstruments Man page
saveSymbols.common Man page
saveSymbols.days Man page
setSymbolLookup.FI Man page
sort_ids Man page
sort.instrument Man page
spread Man page
stock Man page
synthetic Man page
synthetic.instrument Man page
.to_daily Man page
to_secBATV Man page
update_instruments.instrument Man page
update_instruments.iShares Man page
update_instruments.masterDATA Man page Man page
update_instruments.morningstar Man page Man page
update_instruments.SPDR Man page
update_instruments.TTR Man page Man page
volep Man page


inst/tests/test-getSymbols.FI.R inst/tests/test-C2M.R inst/tests/test-instrument.R inst/tests/test-redenominate.R
inst/parser/download.TrueFX.R inst/parser/parse.EODdata.R inst/parser/download.MorningstarCLSIndex.R inst/parser/DJIA.index.R inst/parser/ inst/parser/ inst/parser/parse.Morningstar.R inst/parser/download.goldPrices.R inst/parser/TRTH_BackFill.R inst/parser/parse.MSCI.R inst/parser/download.DJUBSindex.R inst/parser/parse.SP500TR.R inst/parser/download.NAREIT.R inst/parser/calc.GS10TR.R inst/parser/download.tblox.R
demo/demo.R demo/FIdemo2.R
R/ls_instruments.R R/FinancialInstrument-package.R R/splice.R R/update_instruments.morningstar.R R/splooth.R R/MonthCodes.R R/ls_strikes.R R/load.instruments.R R/all.equal.instrument.R R/ R/update_instruments.iShares.R R/build_symbols.R R/find.instrument.R R/ls_instruments_by.R R/redenominate.R R/buildSpread.R R/saveSymbols.R R/instrument.table.R R/volep.R R/expires.R R/Tick2Sec.R R/buildHierarchy.R R/saveInstruments.R R/ls_by_expiry.R R/parse_id.R R/ls_expiries.R R/instrument.R R/FindCommonInstrumentAttributes.R R/CompareInstrumentFiles.R R/synthetic.R R/ls_underlyings.R R/Notionalize.R R/ls_by_currency.R R/format_id.R
man/series_instrument.Rd man/to_daily.Rd man/buildRatio.Rd man/Tick2Sec.Rd man/expires.xts.Rd man/find.instrument.Rd man/FindCommonInstrumentAttributes.Rd man/ man/build_series_symbols.Rd man/make_spread_id.Rd man/redenominate.Rd man/instrument.Rd man/sort_ids.Rd man/all.equal.instrument.Rd man/getSymbols.FI.Rd man/parse_id.Rd man/ls_by_currency.Rd man/update_instruments.instrument.Rd man/expires.instrument.Rd man/ man/update_instruments.masterDATA.Rd man/print.suffix.list.Rd man/Notionalize.Rd man/CompareInstrumentFiles.Rd man/expires.spread.Rd man/C2M.Rd man/get_rate.Rd man/ls_expiries.Rd man/update_instruments.morningstar.Rd man/build_spread_symbols.Rd man/add.identifier.Rd man/update_instruments.iShares.Rd man/formatSpreadPrice.Rd man/load.instruments.Rd man/expires.character.Rd man/buildSpread.Rd man/ man/format_id.Rd man/print.instrument.Rd man/instrument_attr.Rd man/ls_by_expiry.Rd man/saveInstruments.Rd man/ls_instruments_by.Rd man/fn_SpreadBuilder.Rd man/setSymbolLookup.FI.Rd man/ls_strikes.Rd man/exchange_rate.Rd man/buildHierarchy.Rd man/volep.Rd man/expires.Rd man/saveSymbols.days.Rd man/ls_instruments.Rd man/FinancialInstrument-package.Rd man/root_contracts.Rd man/ man/ man/synthetic.instrument.Rd man/currencies.Rd man/ man/getInstrument.Rd man/ man/is.currency.Rd man/parse_suffix.Rd man/next.future_id.Rd man/instrument.table.Rd man/ls_underlyings.Rd man/sort.instrument.Rd man/month_cycle2numeric.Rd man/is.instrument.Rd

Questions? Problems? Suggestions? or email at

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.