create_timezero: Create a timezero

In zoltr: Interface to the 'Zoltar' Forecast Repository API

Create a timezero

Description

Creates the timezero in the passed project using the passed list. Fails if a timezero with the passed timezero_date already exists.

Usage

create_timezero(
  zoltar_connection,
  project_url,
  timezero_date,
  data_version_date = NULL,
  is_season_start = FALSE,
  season_name = ""
)

Arguments

zoltar_connection	A ZoltarConnection object as returned by new_connection()
project_url	url of a project in zoltar_connection's projects. this is the project the new timezero will be created in
timezero_date	The timezero's date in YYYY-MM-DD format as documented at https://docs.zoltardata.com/fileformats/#project-creation-configuration-json
data_version_date	Optional data version date in the same format. Pass NULL if the timezero does not have one
is_season_start	TRUE if this starts a season, and FALSE otherwise
season_name	Applicable when is_season_start is true, names the season, e.g., "2010-2011"

Value

model_url of the newly-created timezero

Examples

## Not run: 
  new_timezero_url <- create_timezero(conn, "https://www.zoltardata.com/api/project/9/",
                     "2022-11-08", "2022-11-09", TRUE, "2010-2011")

## End(Not run)

zoltr documentation built on April 4, 2025, 1:27 a.m.