tweak: documentation

R/RblQuery.R

@@ -43,10 +43,10 @@
 #' @examples 
 #' \dontrun{
 #' # Run RblConnect first
-#' x <- RblQuery(fields = c('PX_LAST', 'PX_OPEN', 'PX_HIGH', 'PX_LOW'), 
-#'               identifiers = c('SXXE Index', "SX5E Index"), 
-#'               from = '2005-01-01')
-#' str(x)
+#' data <- RblQuery(fields = c('PX_LAST', 'PX_OPEN', 'PX_HIGH', 'PX_LOW'), 
+#'                  identifiers = c('SXXE Index', "SX5E Index"), 
+#'                  from = '2005-01-01')
+#' str(data)
 #' }
 #' 
 #' @export

R/core.R

@@ -137,11 +137,14 @@ RblFiles <- function(){
 #' 
 #' # Build a request file to download the daily closing prices of 
 #' #  EURO STOXX Index from 2005-01-01 to 2015-12-31.
-#' RblRequest <- RblRequestBuilder(header = c(FIRMNAME = RblUser(), 
-#'                                            PROGRAMNAME = 'gethistory', 
-#'                                            DATERANGE = '20050101|20151231'), 
-#'                                 fields = c('PX_LAST'), 
-#'                                 identifiers = c('SXXE Index'))
+#' RblRequest <- 
+#'      RblRequestBuilder(
+#'           header = c(FIRMNAME = RblUser(), 
+#'                      PROGRAMNAME = 'gethistory', 
+#'                      DATERANGE = '20050101|20151231'),
+#'           fields = c('PX_LAST'), 
+#'           identifiers = c('SXXE Index')
+#'      )
 #' RblRequest
 #' }
 #' 
@@ -214,11 +217,14 @@ RblRequestBuilder <- function(header, fields, identifiers, overrides = c()) {
 #' 
 #' # Build a request file to download the daily closing prices of 
 #' #  EURO STOXX Index from 2005-01-01 to 2015-12-31.
-#' RblRequest <- RblRequestBuilder(header = c(FIRMNAME = RblUser(), 
-#'                                            PROGRAMNAME = 'gethistory', 
-#'                                            DATERANGE = '20050101|20151231'), 
-#'                                 fields = c('PX_LAST'), 
-#'                                 identifiers = c('SXXE Index'))
+#' RblRequest <- 
+#'      RblRequestBuilder(
+#'           header = c(FIRMNAME = RblUser(), 
+#'                      PROGRAMNAME = 'gethistory', 
+#'                      DATERANGE = '20050101|20151231'),
+#'           fields = c('PX_LAST'), 
+#'           identifiers = c('SXXE Index')
+#'      )
 #'                                 
 #' # Upload the request file
 #' req <- RblUpload(RblRequest)
@@ -277,11 +283,14 @@ RblUpload <- function(RblRequest, filename = format(Sys.time(), "%m%d%H%M%S"), v
 #' 
 #' # Build a request file to download the daily closing prices of 
 #' #  EURO STOXX Index from 2005-01-01 to 2015-12-31.
-#' RblRequest <- RblRequestBuilder(header = c(FIRMNAME = RblUser(), 
-#'                                            PROGRAMNAME = 'gethistory', 
-#'                                            DATERANGE = '20050101|20151231'), 
-#'                                 fields = c('PX_LAST'), 
-#'                                 identifiers = c('SXXE Index'))
+#' RblRequest <- 
+#'      RblRequestBuilder(
+#'           header = c(FIRMNAME = RblUser(), 
+#'                      PROGRAMNAME = 'gethistory', 
+#'                      DATERANGE = '20050101|20151231'),
+#'           fields = c('PX_LAST'), 
+#'           identifiers = c('SXXE Index')
+#'      )
 #'                                 
 #' # Upload the request file
 #' req <- RblUpload(RblRequest)
@@ -361,11 +370,14 @@ RblDownload <- function(file, frequency = 60, timeout = 3600, verbose = TRUE) {
 #' 
 #' # Build a request file to download the daily closing prices of 
 #' #  EURO STOXX Index from 2005-01-01 to 2015-12-31.
-#' RblRequest <- RblRequestBuilder(header = c(FIRMNAME = RblUser(), 
-#'                                            PROGRAMNAME = 'gethistory', 
-#'                                            DATERANGE = '20050101|20151231'), 
-#'                                 fields = c('PX_LAST'), 
-#'                                 identifiers = c('SXXE Index'))
+#' RblRequest <- 
+#'      RblRequestBuilder(
+#'           header = c(FIRMNAME = RblUser(), 
+#'                      PROGRAMNAME = 'gethistory', 
+#'                      DATERANGE = '20050101|20151231'),
+#'           fields = c('PX_LAST'), 
+#'           identifiers = c('SXXE Index')
+#'      )
 #'                                 
 #' # Upload the request file
 #' req <- RblUpload(RblRequest)
@@ -375,7 +387,7 @@ RblDownload <- function(file, frequency = 60, timeout = 3600, verbose = TRUE) {
 #' 
 #' # Import the data
 #' data <- RblParse(out)
-#' data
+#' str(data)
 #' }
 #' 
 #' @import xts