rt_login: Log in to RT

Description Usage Arguments Details Value Examples

View source: R/rt_login.R

Description

Use this to log into RT at the start of your session. Once you call this function and successfully log in, calls of other functions within this package will re-use your login information automatically.

Usage

1
2
3
4
5
rt_login(
  user = Sys.getenv("RT_USER"),
  password = Sys.getenv("RT_PASSWORD"),
  ...
)

Arguments

user

(character) Your username.

password

(character) Your password.

...

Other arguments passed to rt_POST

Details

The value of rt_base_url should be the same address you use in your web browser to log into RT (i.e., the address of the log in page).

Value

Either TRUE, invisibly, if logged in, or throws an error.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
# You can setup the location of your RT installation and the values for
# your credentials as environmental variables
Sys.setenv("RT_USER" = "user",
           "RT_PASSWORD" = "password",
           "RT_BASE_URL" = "https://demo.bestpractical.com")

# And then log in directly like
rt_login()

# You can also skip setting `RT_USER` and `RT_PASSWORD` and specify them
# directly
rt_login("user", "password")
# Note that you still need to set `RT_BASE_URL`

## End(Not run)

rt documentation built on April 28, 2020, 1:08 a.m.