get_users: Get user data from Go.Data
In WorldHealthOrganization/godataR: Connecting R with the Go.Data Application

get_users

R Documentation

Get user data from Go.Data

Description

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

Usage

get_users(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. Some fields, such as addresses, hospitalization history, and questionnaire fields may require further unnesting. See nest for assitance with unnesting.

Examples

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

users <- get_users(
  url = url,
  username = username,
  password = password
)

## End(Not run)

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