read_repo_config: Load data repository configuration file

Description Usage Arguments Details

View source: R/read_repo_config.R

Description

This configuration file specifies global settings that control the synchronization behaviour in general, and provides details of each of the datasets in the repository. Any global configuration setting can also be set at the dataset level. A dataset inherits any global configuration settings not overridden in its own configuration. It is suggested that a user only makes changes to the local_config_file, because package updates may change the default configuration file provided with the package. To use only a local_config_file, specify NULL for the default_config_file (and vice-versa).

Usage

1
2
3
read_repo_config(local_config_file,
  default_config_file = system.file("extdata", "raad_repo_config.json",
  package = "raadsync"))

Arguments

local_config_file

string: file or URL to JSON configuration file.

default_config_file

string: file or URL to JSON configuration file. By default, the default_config_file is the one that ships with this package.

Details

The global settings include the following parameters:

Each dataset is specified by the following parameters in the configuration file:


AustralianAntarcticDataCentre/raadsync documentation built on May 5, 2019, 8:14 a.m.