set_rhdx_config: Set rhdx config

In dickoa/rhdx: A Client for the Humanitarian Data Exchange platform API

Description

Sets the configuration settings for using rhdx.

Usage

set_rhdx_config(
  hdx_site = "prod",
  hdx_key = NULL,
  read_only = TRUE,
  hdx_config = NULL,
  hdx_config_file = NULL,
  configuration = NULL
)

get_rhdx_config()

Arguments

hdx_site	Character to specify which HDX server you want to use. Default to "prod".
hdx_key	Character for the CKAN API key, it is required to push data into HDX
read_only	Logical if FALSE and hdx_key provided is correct you can push metdata and data to HDX
hdx_config	List of HDX configuration
hdx_config_file	Character, path of the HDX config file in JSON and YAML format
configuration	Configuration object.

Details

Setting up a configuration will help you access from an HDX server

Value

Invisibly returns the rhdx config object

Examples

## Not run: 
# Setting the config to use HDX default server
set_rhdx_config(hdx_site = "demo")

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

## End(Not run)

dickoa/rhdx documentation built on Oct. 13, 2021, 8:36 p.m.