montagu_server: Create a handle to a montagu server

Description Usage Arguments Value

View source: R/auth.R

Description

Create a handle to a montagu server

Usage

1
2
3
montagu_server(name, host, port = 443, username = NULL,
  password = NULL, verbose = FALSE, global = TRUE,
  overwrite = FALSE)

Arguments

name

The name to call this server. This appears in a few places as a "friendly" name. If global = TRUE then this will be available from the package using this name.

host

The hostname of the server

port

The port the server is running on (default is 443 which is the standard https port)

username

The username. If not given, then on authorisation, the user will be prompted. Falls back on the R global options montagu.<name>.username and montagu.username in turn.

password

The password. If not given, then on authorisation, the user will be prompted. Falls back on the R global options montagu.<name>.password and montagu.password in turn.

verbose

Logical, indicating if verbose http communication should be used. This is for debugging only.

global

Logical, indicating if the server should be stored in the global set. If true then you can pass location = name to most other functions in the package.

overwrite

Logical, and meaningful only if global = TRUE, indicating if a global configuration should be replaced if it exists.

Value

Invisibly, a montagu_server object.


vimc/montagu-r documentation built on Oct. 10, 2019, 9:10 p.m.