mica.login: Open connection with Mica

Description Usage Arguments Value Examples

View source: R/mica.R

Description

Open a connection with Mica and returns a Mica object.

Usage

1
2
3
4
5
6
mica.login(
  username = getOption("mica.username", "anonymous"),
  password = getOption("mica.password", "password"),
  url = getOption("mica.url"),
  opts = getOption("mica.opts", list())
)

Arguments

username

User name in mica. Can be provided by "mica.username" option.

password

User password in mica. Can be provided by "mica.password" option.

url

Mica url or list of mica urls. Can be provided by "mica.url" option.

opts

Curl options. Can be provided by "mica.opts" option.

Value

A Mica object.

Examples

1
2
3
4
5
6
7
## Not run: 
# login using credentials from mica.username and mica.password options
m <- mica.login("https://mica-demo.obiba.org")
# login by providing credentials
m <- mica.login("administrator", "password", "https://mica-demo.obiba.org")

## End(Not run)

micar documentation built on April 16, 2021, 5:09 p.m.