Create a RIDL configuration object — ridl

Create and RIDL configuration object

Sets the configuration settings for using RIDL.

Usage

ridl_config(
  site = "prod",
  token = NULL,
  key = NULL,
  user_agent = NULL,
  log_file = NULL,
  ...
)

ridl_config_set(
  site = "prod",
  token = NULL,
  key = NULL,
  user_agent = NULL,
  log_file = NULL,
  configuration = NULL,
  ...
)

ridl_config_setup(
  site = "prod",
  token = NULL,
  key = NULL,
  user_agent = NULL,
  log_file = NULL,
  configuration = NULL,
  ...
)

ridl_config_get()

Arguments

site: character, the RIDL instance, prod (production server), test (testing server)
token: character, the CKAN API token
key: character, the CKAN API key
user_agent: a character, A user agent string
log_file: character, the log file
...: curl options to pass to crul::HttpClient
configuration: RIDLConfig, the configuration

Value

A RIDLConfig object

Invisibly returns the ridl config object

Details

Setting up a configuration will help you access from a RIDL server

Examples

if (FALSE) {
# Setting the config to use RIDL default server
ridl_config_set(ridl_key = "xxxxxxxxxx")

# You can check your configuration using \code{ridl_config_get}
config <- ridl_config_get()
config
}