Skip to contents

Situation report for your Tally setup

Source: R/sitrep.R
tally_sitrep.Rd

Reports everything relevant to tallyr working: which accounts have keys available and which is active, whether the active account's API key was found (and where), whether it looks like a Tally key, whether you are online, and whether the key actually authenticates against the Tally API. Ends with recommendations for fixing anything that's wrong. Never errors, whatever the state of your setup.

Usage

tally_sitrep(account = NULL)

Arguments

account

The name of the Tally account whose key to use, e.g. "work" for a key stored in TALLY_API_KEY_WORK. The default NULL uses the account selected with tally_use_account(), or failing that the default account (TALLY_API_KEY).

Value

Invisibly, a list with components api_key (the key status), accounts (available account names), online (logical) and user (the authenticated user, or NULL if the connectivity test failed or wasn't run).

See also

tally_api_key(), tally_use_account(), tally_whoami()

Examples

if (FALSE) { # \dontrun{
tally_sitrep()
} # }