get_active_outbreak: Get the currently active outbreak id number
In WorldHealthOrganization/godataR: Connecting R with the Go.Data Application

get_active_outbreak

R Documentation

Get the currently active outbreak id number

Description

A function to retrieve the active outbreak ID number for the provided username. Each Go.Data user can have 1 and only 1 active outbreak at a given time. This is a housekeeping function used in many of the other godataR functions.

Usage

get_active_outbreak(url, username, password)

Arguments

`url`	Insert the base URL for your instance of Go.Data here. Don't forget the forward slash "/" at end!
`username`	The email address for your Go.Data login.
`password`	The password for your Go.Data login.

Value

Returns a string with the Outbreak ID number of the user's active outbreak.

Examples

## Not run: 
url <- "https://MyGoDataServer.com/"
username <- "myemail@email.com"
password <- "mypassword"

active_outbreak_id <- get_active_outbreak(
  url = url,
  username = username,
  password = password
)

## End(Not run)

WorldHealthOrganization/godataR documentation built on May 21, 2023, 11:30 a.m.