bds {Rblpapi}

Run 'Bloomberg Data Set' Queries

Description

This function uses the Bloomberg API to retrieve 'bds' (Bloomberg Data Set) queries

Usage

bds(security, field, options = NULL, overrides = NULL, verbose = FALSE,
  identity = defaultAuthentication(), con = defaultConnection(),
  simplify = getOption("blpSimplify", TRUE))

Arguments

security

A character value with a single security symbol in Bloomberg notation.

field

A character string with a single Bloomberg query field.

options

An optional named character vector with option values. Each field must have both a name (designating the option being set) as well as a value.

overrides

An optional named character vector with override values. Each field must have both a name (designating the override being set) as well as a value.

verbose

A boolean indicating whether verbose operation is desired, defaults to ‘FALSE’

identity

An optional identity object as created by a blpAuthenticate call, and retrived via the internal function defaultAuthentication.

con

A connection object as created by a blpConnect call, and retrieved via the internal function defaultConnection.

simplify

A boolean indicating whether result objects that are one element lists should be altered to returned just the single inner object. Defaults to the value of the ‘blpSimplify’ option, with a fallback of ‘TRUE’ if unset ensuring prior behavior is maintained.

Value

A data frame object with the requested data set.

Author(s)

Whit Armstrong and Dirk Eddelbuettel

Examples

## Not run: 
  ## simple query
  bds("GOOG US Equity", "TOP_20_HOLDERS_PUBLIC_FILINGS")
  ## example of using overrides
  overrd <- c("START_DT"="20150101", "END_DT"="20160101")
  bds("CPI YOY Index","ECO_RELEASE_DT_LIST", overrides = overrd)

## End(Not run)