all set-up to prepare ultimate test before last reports
[talweg.git] / pkg / R / getData.R
index 153a660..574522b 100644 (file)
 #'
 #' @return An object of class Data
 #'
+#' @example
+#' ts_data = read.csv(system.file("extdata",ts_data,package="talweg",mustWork=TRUE))
+#' exo_data = read.csv(system.file("extdata",exo_data,package="talweg",mustWork=TRUE))
+#' getData(ts_data, exo_data, ...)
+#'
 #' @export
 getData = function(ts_data, exo_data, input_tz="GMT", date_format="%d/%m/%Y %H:%M",
        working_tz="GMT", predict_at=0, limit=Inf)
@@ -26,10 +31,13 @@ getData = function(ts_data, exo_data, input_tz="GMT", date_format="%d/%m/%Y %H:%
                stop("Bad timezone (see ?timezone)")
        input_tz = input_tz[1]
        working_tz = working_tz[1]
-       if (!is.data.frame(ts_data) && !is.character(ts_data))
-               stop("Bad time-series input (data frame or CSV file)")
+       if ( (!is.data.frame(ts_data) && !is.character(ts_data)) ||
+                       (!is.data.frame(exo_data) && !is.character(exo_data)) )
+               stop("Bad time-series / exogenous input (data frame or CSV file)")
        if (is.character(ts_data))
                ts_data = ts_data[1]
+       if (is.character(exo_data))
+               exo_data = exo_data[1]
        predict_at = as.integer(predict_at)[1]
        if (predict_at<0 || predict_at>23)
                stop("Bad predict_at (0-23)")
@@ -38,17 +46,15 @@ getData = function(ts_data, exo_data, input_tz="GMT", date_format="%d/%m/%Y %H:%
        date_format = date_format[1]
 
        ts_df =
-               if (is.character(ts_data)) {
+               if (is.character(ts_data))
                        read.csv(ts_data)
-               } else {
+               else
                        ts_data
-               }
        exo_df =
-               if (is.character(exo_data)) {
+               if (is.character(exo_data))
                        read.csv(exo_data)
-               } else {
+               else
                        exo_data
-               }
        # Convert to the desired timezone (usually "GMT" or "Europe/Paris")
        formatted_dates_POSIXlt = strptime(as.character(ts_df[,1]), date_format, tz=input_tz)
        ts_df[,1] = format(as.POSIXct(formatted_dates_POSIXlt), tz=working_tz, usetz=TRUE)