amcat.connect: Connect to the AmCAT API

Description Usage Arguments Value

View source: R/amcatr.r

Description

Connect to the AmCAT API and requests a temporary (24h) authentication token that will be stored in the output The host should be known in the ~/.amcatauth file, you can use amcat.save.password to add a password to this file

Usage

1
2
3
4
5
6
7
amcat.connect(
  host,
  token = NULL,
  disable_ipv6 = TRUE,
  ssl.verifypeer = FALSE,
  passwordfile = "~/.amcatauth"
)

Arguments

host

the hostname, e.g. http://amcat.vu.nl or http://localhost:8000

token

an existing token to authenticate with. If given, username and password are not used and the token is not tested

passwordfile

optionally, specify a different password file

disable_ipv6.

If True, only use ipv4 resolving (faster if ipv6 causes timeout). Defaults to true, but this may change in the future.

Value

A list with authentication information that is used by the other functions in this package


amcat/amcat-r documentation built on Dec. 26, 2021, 3:12 a.m.