making beqs() actually callable

ChangeLog

@@ -1,3 +1,9 @@
+2015-10-03  Dirk Eddelbuettel  <[email protected]>
+
+	* man/beqs.Rd: Added by running roxygenize()
+	* src/RcppExports.cpp: Updated by running compileAttributes()
+	* R/RcppExports.R: Updated by running compileAttributes()
+
 2015-10-03  Rademeyer Vermaak  <[email protected]>
 
 	* src/beqs.cpp: Add BEQS functionality

R/RcppExports.R

@@ -17,6 +17,10 @@ bds_Impl <- function(con_, securities, field, options_, overrides_, identity_) {
     .Call('Rblpapi_bds_Impl', PACKAGE = 'Rblpapi', con_, securities, field, options_, overrides_, identity_)
 }
 
+beqs_Impl <- function(con_, screenName, screenType_, Group_, PiTDate_, languageId_) {
+    .Call('Rblpapi_beqs_Impl', PACKAGE = 'Rblpapi', con_, screenName, screenType_, Group_, PiTDate_, languageId_)
+}
+
 blpConnect_Impl <- function(host, port) {
     .Call('Rblpapi_blpConnect_Impl', PACKAGE = 'Rblpapi', host, port)
 }

man/beqs.Rd

@@ -0,0 +1,47 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/beqs.R
+\name{beqs}
+\alias{beqs}
+\title{Run 'Bloomberg EQS' Queries}
+\usage{
+beqs(screenName, screenType = "GLOBAL", languageID = NULL, Group = NULL,
+  PiTDate = NULL, con = defaultConnection())
+}
+\arguments{
+\item{screenName}{A character string with the name of the screen to execute.
+It can be a user defined EQS screen or one of the Bloomberg Example screens on EQS}
+
+\item{screenType}{A character string of value PRIVATE or GLOBAL
+Use PRIVATE for user-defined EQS screen.
+Use GLOBAL for Bloomberg EQS screen.}
+
+\item{languageID}{An optional character string with the EQS language}
+
+\item{Group}{An optional character string with the Screen folder name as defined in EQS}
+
+\item{PiTDate}{A character string with the Point in Time Date of the screen to execute.
+Format = "YYYYMMDD"}
+
+\item{con}{A connection object as created by a \code{blpConnect}
+call, and retrieved via the internal function
+\code{defaultConnection}.}
+}
+\value{
+A matrix with requested EQS data
+}
+\description{
+This function uses the Bloomberg API to retrieve 'beqs' (Bloomberg
+EQS Data) queries
+}
+\examples{
+\dontrun{
+beqs("Global Oil Companies YTD Return","GLOBAL")
+beqs("Global Oil Companies YTD Return","GLOBAL","GERMAN")
+beqs("Global Oil Companies YTD Return","GLOBAL","GERMAN","GENERAL")
+beqs("Global Oil Companies YTD Return","GLOBAL","ENGLISH","GENERAL","20150930")
+}
+}
+\author{
+Whit Armstrong, Dirk Eddelbuettel
+}
+

src/RcppExports.cpp

@@ -68,6 +68,22 @@ BEGIN_RCPP
     return __result;
 END_RCPP
 }
+// beqs_Impl
+SEXP beqs_Impl(SEXP con_, std::string screenName, std::string screenType_, SEXP Group_, SEXP PiTDate_, SEXP languageId_);
+RcppExport SEXP Rblpapi_beqs_Impl(SEXP con_SEXP, SEXP screenNameSEXP, SEXP screenType_SEXP, SEXP Group_SEXP, SEXP PiTDate_SEXP, SEXP languageId_SEXP) {
+BEGIN_RCPP
+    Rcpp::RObject __result;
+    Rcpp::RNGScope __rngScope;
+    Rcpp::traits::input_parameter< SEXP >::type con_(con_SEXP);
+    Rcpp::traits::input_parameter< std::string >::type screenName(screenNameSEXP);
+    Rcpp::traits::input_parameter< std::string >::type screenType_(screenType_SEXP);
+    Rcpp::traits::input_parameter< SEXP >::type Group_(Group_SEXP);
+    Rcpp::traits::input_parameter< SEXP >::type PiTDate_(PiTDate_SEXP);
+    Rcpp::traits::input_parameter< SEXP >::type languageId_(languageId_SEXP);
+    __result = Rcpp::wrap(beqs_Impl(con_, screenName, screenType_, Group_, PiTDate_, languageId_));
+    return __result;
+END_RCPP
+}
 // blpConnect_Impl
 SEXP blpConnect_Impl(const std::string host, const int port);
 RcppExport SEXP Rblpapi_blpConnect_Impl(SEXP hostSEXP, SEXP portSEXP) {