kobo_token: Get your KoboToolbox API token

In dickoa/robotoolbox: Client for the 'KoboToolbox' API

Get your KoboToolbox API token

Description

Get your KoboToolbox API token from your username and password.

Usage

kobo_token(username = NULL, password = NULL, url = NULL, overwrite = FALSE)

Arguments

username	character, KoboToolbox account username.
password	character, KoboToolbox account password.
url	character, KoboToolbox server URL.
overwrite	logical, if TRUE, it overwrites the existing token. Default to FALSE.

Value

A character, the KoboToolbox API token. It also stores, as a side effect, the URL and token as the environment variables KOBOTOOLBOX_URL and KOBOTOOLBOX_TOKEN respectively.

Examples

## Not run: 
# use your own KoboToolbox URL, username and password
if (require(askpass)) {
 token <- kobo_setup(username = "cool_user_name",
                     password = askpass::askpass(),
                     url = "https://kf.kobotoolbox.org/")
 token
 }

## End(Not run)

dickoa/robotoolbox documentation built on Dec. 20, 2024, 12:33 a.m.