tibbr.connect: Connect To tibbr

Description Usage Arguments Details Value See Also Examples

View source: R/connect.R

Description

Creates a connection to the tibbr service.

Usage

1
2
3
4
5
tibbr.connect(server, user, password)
tibbr.disconnect(connection)

## S3 method for class 'tibbrConnection'
print(x, ...)

Arguments

server

a character string containing the hostname of the tibbr instance to connect to. Do not include the http:// or https:// prefix.

user

a character string specifying the name of the tibbr user to connect as.

password

a character string containing the password of the tibbr user to connect as.

connection

a tibbrConnection object from which to disconnect.

x

an object that inherits from class "tibbrConnection".

...

additional arguments passed to the print method.

Details

Errors encountered during the tibbr login or logout process are raised by these functions.

Value

tibbr.connect

returns a tibbrConnection object containing the following items:

  • server – The name of the server to which this object is connected.

  • user – The authentication information returned by the tibbr API.

  • clientkey – The tibbr API client key that references the authenticated session this object represents.

tibbr.disconnect

returns TRUE invisibly.

See Also

tibbr.post

Examples

1
2
3
4
5
6
## Not run: 
con <- tibbr.connect("try.tibbr.com", "myusername", "mypassword")
con
tibbr.disconnect(con)

## End(Not run)

tibbrConnector documentation built on May 2, 2019, 11:02 a.m.