zoltr (version 0.5.1)

upload_forecast: Upload a forecast

Description

This function submits forecast data to the server for uploading. Returns an UploadFileJob object that can be used to up, which depends on the number of current uploads in the queue. Zoltar tracks these via `UploadFileJob` objects.)

Usage

upload_forecast(
  zoltar_connection,
  model_url,
  timezero_date,
  forecast_data,
  notes = ""
)

Arguments

zoltar_connection

A `ZoltarConnection` object as returned by new_connection

model_url

URL 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_data

Forecast data as a `list` in the Zoltar standard format

notes

Optional user notes for the new forecast

Value

An UploadFileJob URL for the upload

Examples

# NOT RUN {
  forecast_data <- jsonlite::read_json("docs-predictions.json")
  upload_file_job_url <- upload_forecast(conn, "http://www.zoltardata.com/api/model/1/",
                                         "2017-01-17", forecast_data, "a mid-January forecast")
# }