Title:	Settings and File I/O using a Configuration YAML File
Version:	0.2.0
Description:	R data pipelines commonly require reading and writing data to versioned directories. Each directory might correspond to one step of a multi-step process, where that version corresponds to particular settings for that step and a chain of previous steps that each have their own versions. This package creates a configuration object that makes it easy to read and write versioned data, based on YAML configuration files loaded and saved to each versioned folder.
Depends:	R (≥ 4.1.0)
Imports:	assertthat, glue, R6, yaml
Suggests:	data.table, foreign, haven, readxl, sf, terra, knitr, rmarkdown, testthat (≥ 3.0.0)
License:	MIT + file LICENSE
Encoding:	UTF-8
RoxygenNote:	7.2.3
Config/testthat/edition:	3
VignetteBuilder:	knitr
NeedsCompilation:	no
Packaged:	2025-03-10 23:10:43 UTC; nathenry
Author:	Nathaniel Henry [aut, cre]
Maintainer:	Nathaniel Henry <nat@henryspatialanalysis.com>
Repository:	CRAN
Date/Publication:	2025-03-10 23:50:01 UTC

R6 Class representing a configuration object

Description

R6 Class representing a configuration object

R6 Class representing a configuration object

Details

The special sublist directories is structured to contain three items for each directory name:

• versioned: a T/F value specifying whether the directory is versioned

• path: the full path to the top level of that directory.

• files: A named list referencing file paths within that directory.

If the directory is versioned, a version must be set in the versions sublist of the config list. versions is itself a named list where each key corresponds to a versioned folder in directories and the value gives the particular folder version (for example, a timestamp) that corresponds to the particular run.

Public fields

Methods

Public methods

• Config$new()

• Config$print()

• Config$get()

• Config$get_dir_path()

• Config$get_file_path()

• Config$read()

• Config$write()

• Config$write_self()

• Config$clone()

Method new()

Create a new Config object

Usage

Config$new(config_list, versions = NULL)

Arguments

Method print()

Print the list representation of the Config object

Usage

Config$print()

Method get()

Get a subset of the config_list

Usage

Config$get(...)

Arguments

Details

If no parameters are passed, returns the entire config_list

Returns

A subset of the list. If the item is NULL or missing, returns an error

Method get_dir_path()

Construct a directory path from the config object

Usage

Config$get_dir_path(
  dir_name,
  custom_version = NULL,
  fail_if_does_not_exist = FALSE
)

Arguments

Details

Works differently for versioned and non-versioned directories. See the class description for more information.

Returns

The full path to the directory

Method get_file_path()

Construct a file path from the config object

Usage

Config$get_file_path(
  dir_name,
  file_name,
  custom_version = NULL,
  fail_if_does_not_exist = FALSE
)

Arguments

Details

Looks for the file path under: config_list$directories[[dir_name]]$files[[file_name]]

Returns

The full path to the file Read a file based on the config

Method read()

Usage

Config$read(dir_name, file_name, ..., custom_version = NULL)

Arguments

Returns

The object loaded by autoread() Write an object to file based on the config

Method write()

Usage

Config$write(x, dir_name, file_name, ..., custom_version = NULL)

Arguments

Returns

Invisibly passes TRUE if successful Convenience function: write the config list to a folder as 'config.yaml'

Method write_self()

Usage

Config$write_self(dir_name, ..., custom_version = NULL)

Arguments

Returns

Invisibly passes TRUE if successful

Method clone()

The objects of this class are cloneable with this method.

Usage

Config$clone(deep = FALSE)

Arguments

See Also

pull_from_list()

Auto-read from file

Description

Automatically read a file based on extension

Usage

autoread(file, ...)

Arguments

Value

The object loaded by the file

See Also

get_file_reading_functions() autowrite()

Auto-write to file

Description

Automatically write an object to a file based on extension

Usage

autowrite(x, file, ...)

Arguments

Value

Invisibly passes TRUE if the file saves successfully

See Also

get_file_writing_functions() autoread()

Get the list of file reading functions

Description

Constructs a list of all file-reading functions based on extension

Usage

get_file_reading_functions()

Value

Named list where the names are file extensions, and the values are functions that read a file. All functions have ... arguments that can be used to extend the basic function.

See Also

autoread() get_file_writing_functions()

Get the list of file writing functions

Description

Constructs a list of all file-reading functions based on extension

Usage

get_file_writing_functions()

Value

Named list where the names are file extensions, and the values are functions that read a file. All functions have ... arguments that can be used to extend the basic function.

See Also

autoread() get_file_reading_functions()

Safely pull an item from a list

Description

Indexing function for a list

Usage

pull_from_list(x, ..., fail_if_null = TRUE)

Arguments

Details

Use the ... arguments to index the list. Not passing any ... arguments will return the entire list. The indexing will fail if either of two conditions are met:

1. The index (which can be numeric or a key) does not exist in the list

2. If the index exists but the value of the item is NULL, and fail_if_null is TRUE

Stop without listing the containing function call

Description

Stop without listing the containing function call

Usage

qstop(...)

Arguments

Value

Concisely stops program execution

Require that a namespace be loaded, or stop execution

Description

Require that a namespace be loaded, or stop execution

Usage

require_namespace_or_stop(pkg)

Arguments

Value

Silently loads namespace, or stops execution if package cannot be loaded