reorganize folder

[talweg.git] / pkg / man / getData.Rd

diff --git a/pkg/man/getData.Rd b/pkg/man/getData.Rd
new file mode 100644 (file)
index 0000000..0c960da
--- /dev/null
+++ b/pkg/man/getData.Rd
@@ -0,0 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/getData.R
+\name{getData}
+\alias{getData}
+\title{Acquire data in a clean format}
+\usage{
+getData(ts_data, exo_data, input_tz = "GMT",
+  date_format = "\%d/\%m/\%Y \%H:\%M", working_tz = "GMT", predict_at = 0)
+}
+\arguments{
+\item{ts_data}{Time-series, as a data frame (DB style: 2 columns, first is date/time,
+second is value) or a CSV file}
+
+\item{exo_data}{Exogenous variables, as a data frame or a CSV file; first comlumn is dates,
+next block are measurements for the day, and final block are exogenous forecasts}
+
+\item{input_tz}{Timezone in the input files ("GMT" or e.g. "Europe/Paris")}
+
+\item{date_format}{How date/time are stored (e.g. year/month/day hour:minutes;
+see \code{strptime})}
+
+\item{working_tz}{Timezone to work with ("GMT" or e.g. "Europe/Paris")}
+
+\item{predict_at}{When does the prediction take place ? Integer, in hours. Default: 0}
+}
+\value{
+An object of class Data
+}
+\description{
+Take in input data frames and/or files containing raw data, and timezones, and
+  output a Data object, roughly corresponding to a list where each cell contains all value
+  for one day (see \code{?Data}). Current limitation: series (in working_tz) must start at
+  right after midnight (to keep in sync with exogenous vars)
+}
+