gconnect: Connect to Google account

Description Usage Arguments Details Value Note Examples

View source: R/gtrends.R

Description

The resulting connection object is also stored in the package-local environment from which the (internal) helper function .getDefaultConnection() retrieves it as needed.

Usage

1
2
3
gconnect(usr = NULL, psw = NULL, verbose = FALSE)

.getDefaultConnection()

Arguments

usr

User name (ex.: [email protected]); alternatively the environment variable GOOGLE_USER as well as options("google.user") can be used to supply the user name.

psw

Account password; alternatively the environment variable GOOGLE_PASSWORD as well as options("google.password") can be used to supply the password.

verbose

Logical for displaying additional information

Details

If the environment variables GOOGLE_USER and GOOGLE_PASSWORD are set, they will be retrieved in case no argument has been supplied. Similarly, the environment variable options("google.user") or options("google.password") can be used. Lastly, if the environment variable GOOGLE_AUTOCONNECT is set to (the text string) ‘TRUE’, or the the R option options("google.autoconnect") is set to ‘TRUE’ then the connection is automatically made at package load.

Value

A libcurl handle is returned (invisibly).

Note

Should you have trouble connecting, and also use two-factor authentication on your Google Account, then consider creating another Google account (without two-factor authentication) which should allow automated (i.e. programmatic) connection here.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# use with explicit arguments
session <- gconnect("[email protected]", "psw")

# use with arguments stored in env.var or options()
# this is preferred for scripts shared with others who
# can place their secret password in a file only they know
session <- gconnect("[email protected]", "psw")

## End(Not run)

cemigo114/GoogleAPI documentation built on May 12, 2017, 1:16 a.m.