zoltr (version 0.2.2)

upload_forecast: Upload a forecast

Description

This function submits a forecast file to the server for uploading. Returns an UploadFileJob object that can be used to track the upload's progress. (Uploads are processed in a queue, which means they are delayed until their turn comes up, which depends on the number of current uploads in the queue. Zoltar tracks these via `UploadFileJob` objects.)

Usage

upload_forecast(zoltar_connection, model_id, timezero_date,
  forecast_csv_file)

Arguments

zoltar_connection

A `ZoltarConnection` object as returned by new_connection

model_id

ID of a model in zoltar_connection's projects

timezero_date

The date of the project timezero you are uploading for. it is a string in format YYYYMMDD

forecast_csv_file

A CSV file in the Zoltar standard format - see https://www.zoltardata.com/docs#forecasts

Value

An UploadFileJob id for the upload

Examples

# NOT RUN {
  upload_file_job_id <- upload_forecast(conn, 26L, "20170117", "/tmp/EW1-KoTsarima-2017-01-17.csv")
# }