get_locations: Get location data from Go.Data

View source: R/get_locations.R

get_locationsR Documentation

Get location data from Go.Data

Description

A function to retreive a list of all locations and their attributes, across all outbreaks on the instance (since this is a system-level API endpoint). This function relies on the ⁠\locations⁠ API endpoint.

Usage

get_locations(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 data frame of locations associated with Go.Data instance.

Examples

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

locations <- get_locations(
  url = url,
  username = username,
  password = password
)

## End(Not run)

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