This helper function lets you use environment variables to auto-authenticate on package load, intended for calling by gar_attach_auto_auth

gar_auto_auth(required_scopes, new_user = FALSE, no_auto = FALSE,
  environment_var = "GAR_AUTH_FILE",
  travis_environment_var = "TRAVIS_GAR_AUTH_FILE")

Arguments

required_scopes

Required scopes needed to authenticate - needs to match at least one

new_user

If TRUE, reauthenticate via Google login screen

no_auto

If TRUE, ignore auto-authentication settings

environment_var

Name of environment var that contains auth file path

travis_environment_var

Name of Travis environment var that contains auth file path

The authentication file can be a .httr-oauth file created via gar_auth or a Google service JSON file downloaded from the Google API crudential console, with file extension .json.

You can use this in your code to authenticate from a filelocation specified in in file, but it is mainly intended to be called on package load via gar_attach_auto_auth.

environment_var This is the name that will be called via Sys.getenv on library load. The environment variable will contain an absolute file path to the location of an authentication file. travis_environment_var Name that will be called via Sys.getenv in Travis tests. As the working directory is different on travis, this environment variable should contain a relative path to your Github repository home folder.

Value

an OAuth token object, specifically a Token2.0, invisibly

See also

Help files for .onAttach

Other authentication functions: gar_attach_auto_auth, gar_auth_service, gar_auth, gar_gce_auth, get_google_token, is_legit_token, token_exists