| 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/getData.R |
| 3 | \name{getData} |
| 4 | \alias{getData} |
| 5 | \title{Acquire data in a clean format} |
| 6 | \usage{ |
| 7 | getData(ts_data, exo_data, input_tz = "GMT", |
| 8 | date_format = "\%d/\%m/\%Y \%H:\%M", working_tz = "GMT", predict_at = 0) |
| 9 | } |
| 10 | \arguments{ |
| 11 | \item{ts_data}{Time-series, as a data frame (DB style: 2 columns, first is date/time, |
| 12 | second is value) or a CSV file} |
| 13 | |
| 14 | \item{exo_data}{Exogenous variables, as a data frame or a CSV file; first comlumn is dates, |
| 15 | next block are measurements for the day, and final block are exogenous forecasts} |
| 16 | |
| 17 | \item{input_tz}{Timezone in the input files ("GMT" or e.g. "Europe/Paris")} |
| 18 | |
| 19 | \item{date_format}{How date/time are stored (e.g. year/month/day hour:minutes; |
| 20 | see \code{strptime})} |
| 21 | |
| 22 | \item{working_tz}{Timezone to work with ("GMT" or e.g. "Europe/Paris")} |
| 23 | |
| 24 | \item{predict_at}{When does the prediction take place ? Integer, in hours. Default: 0} |
| 25 | } |
| 26 | \value{ |
| 27 | An object of class Data |
| 28 | } |
| 29 | \description{ |
| 30 | Take in input data frames and/or files containing raw data, and timezones, and |
| 31 | output a Data object, roughly corresponding to a list where each cell contains all value |
| 32 | for one day (see \code{?Data}). Current limitation: series (in working_tz) must start at |
| 33 | right after midnight (to keep in sync with exogenous vars) |
| 34 | } |
| 35 | |