set_active_outbreak: Change the currently active outbreak

View source: R/set_active_outbreak.R

set_active_outbreakR Documentation

Change the currently active outbreak

Description

A function to change the user's active outbreak on the Go.Data server. This is a housekeeping function used in many of the other godataR functions.

Usage

set_active_outbreak(url, username, password, outbreak_id)

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

outbreak_id

The id number for the outbreak to set to active.

Details

Each Go.Data user can have 1 and only 1 active outbreak at a given time.

Value

Nothing

Examples

## Not run: 
url <- "https://MyGoDataServer.com/"
username <- "myemail@email.com"
password <- "mypassword"
outbreak_id <- "3b5554d7-2c19-41d0-b9af-475ad25a382b"

set_active_outbreak(
  url = url,
  username = username,
  password = password,
  outbreak_id = outbreak_id
)

## End(Not run)

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