new_connection: Get a connection to a Zoltar host

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

Get a connection to a Zoltar host

Description

Returns a new connection object, which is the starting point for working with the Zoltar API. Once you have the connection you can call zoltar_authenticate() on it, and then call projects() to get a list of Project objects to start working with.

Usage

new_connection(host = "https://zoltardata.com")

Arguments

host	The Zoltar site to connect to. Does not include a trailing slash ('/'). Defaults to https://zoltardata.com

Details

A note on URLs: We require a trailing slash ('/') on all URLs. The only exception is the host arg passed to this function. This convention matches Django REST framework one, which is what Zoltar is written in.

Value

A ZoltarConnection object

Examples

## Not run: 
  conn <- new_connection()

## End(Not run)

reichlab/zoltr documentation built on April 13, 2024, 2:13 a.m.