get_all_outbreaks: Get a list of all outbreaks and their attributes

View source: R/get_all_outbreaks.R

get_all_outbreaksR Documentation

Get a list of all outbreaks and their attributes

Description

A function to retrieve all outbreaks assigned to the provided username. This is a housekeeping function used in many of the other godataR functions.

Usage

get_all_outbreaks(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 data frame of outbreaks. The resulting list is filtered by the user's permissions: only outbreaks for which the user has access will be returned.

Examples

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

outbreaks <- get_all_outbreaks(
  url = url,
  username = username,
  password = password
)

## End(Not run)

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