FSLRethoConfiguration: Configuration of FSLRetho

In shaliulab/fslretho: fslretho: a Shiny GUI to the Rethomics suite

Configuration of FSLRetho

Description

Load and update the configuration of the program

Details

Anywhere in FSLRetho 'FSLRethoConfiguration' can be instantiated so default values for hardware defined parameters can be set dynamically via a config file

Public fields

content

List of configuration items

config_file

Default configuration file path Initialize a configuration instance Called by running 'FSLRethoConfiguration$new()'

Methods

Public methods

• FSLRethoConfiguration$new()

• FSLRethoConfiguration$save()

• FSLRethoConfiguration$load()

• FSLRethoConfiguration$clone()

---

Method new()

Usage

FSLRethoConfiguration$new(config_file = "/etc/fslretho.conf")

Arguments

config_file

Path to the default configuration file Save the configuration in to a config_file

Save the configuration stored in self$content If the passed config_file is null, use the instance's default

---

Method save()

Usage

FSLRethoConfiguration$save(config_file)

Arguments

config_file

Configuration file path Load a a configuration from a config_file If the passed config_file is null, use the instance's default If the passed file does not exist create it with the conf in the default file If it exists, load its contents and update the configuration

---

Method load()

Usage

FSLRethoConfiguration$load(config_file)

Arguments

config_file

Configuration file path

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FSLRethoConfiguration$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

shaliulab/fslretho documentation built on Jan. 30, 2023, 9:16 p.m.