s2dverification (version 2.4.0)

ConfigShowTable: Show Configuration Tables Lists And Definitions

Description

These functions show the tables of supported datasets, lists of supported variables and definitions in a configuration object obtained via ConfigFileCreate() or ConfigFileOpen().

Usage

ConfigShowTable(configuration, dataset_type, store_format, line_numbers = NULL)
ConfigShowDefinitions(configuration)
ConfigShowVars(configuration)

Value

These functions return nothing.

See Also

ConfigAddVar, ConfigApplyMatchingEntries, ConfigEditDefinition, ConfigEditEntry, ConfigFileOpen, ConfigMatchingVars, ConfigShowSimilarEntries, ConfigShowTable

Examples

# Create an empty configuration file
config_file <- paste0(tempdir(), "/example.conf")
ConfigFileCreate(config_file, confirm = FALSE)
# Open it into a configuration object
configuration <- ConfigFileOpen(config_file)
# Add an entry at the bottom of 4th level of file-per-startdate experiments 
# table which will associate the experiment "ExampleExperiment2" and variable 
# "ExampleVariable" to some information about its location.
configuration <- ConfigAddEntry(configuration, "experiments", 
                 "file-per-startdate", "last", "ExampleExperiment2", 
                 "ExampleVariable", "/path/to/ExampleExperiment2", 
                 "ExampleVariable/ExampleVariable_$START_DATE$.nc")
# Edit entry to generalize for any variable. Changing variable needs .
configuration <- ConfigEditEntry(configuration, "experiments", 
                 "file-per-startdate", 1, var_name = ".*", 
                 file_path = "$VAR_NAME$/$VAR_NAME$_$START_DATE$.nc")
# Now put a pattern to the list of supported variables. 
# In this example will be a two-dimensional variable.
configuration <- ConfigAddVar(configuration, "2d", "Example.*Variable")
# Show tables, lists and definitions
ConfigShowTable(configuration, 'experiments', 'file-per-startdate')
ConfigShowVars(configuration)
ConfigShowDefinitions(configuration)