write_YAMLConfigFile | R Documentation |
This little function helps to auto-generate a the BayLum YAML configuration file or a list that can be passed to create_DataFile. The YAML file itself can be modified in any text editor. The allowed parameters are extracted from the reference YAML file
write_YAMLConfigFile(output_file = NULL, ...)
output_file |
character (with default): valid file path of the output file |
... |
parameters to be preset in the YAML file (run |
The function has two output modes:
(1) output_file = <file_path>
: Writes a YAML into the specified path and returns this path.
(2) output_file = NULL
: Returns a list of allowed function parameters that can be passed
to the function and it returns a list that can be used a passed on to create_DataFile.
0.1.0
Kreutzer, S., 2024. write_YAMLConfigFile(): Write Auto Generated YAML BayLum Configuration File to the Disc. Function version 0.1.0. In: Christophe, C., Philippe, A., Kreutzer, S., Guérin, G., Baumgarten, F.H., Frerebeau, N., 2024. BayLum: Chronological Bayesian Models Integrating Optically Stimulated. R package version 0.3.2. https://CRAN.r-project.org/package=BayLum
Sebastian Kreutzer, Institute of Geography, Ruprecht-Karl University of Heidelberg (Germany)
create_DataFile, yaml::read_yaml, Luminescence::read_BIN2R, Luminescence::read_XSYG2R
## generate list
write_YAMLConfigFile(
sample = c("samp1", "samp2"),
settings.rules.endTest = 10)
## generate file (here written in tempdir)
write_YAMLConfigFile(
output_file = tempfile("configuration.yml"),
sample = c("samp1", "samp2"),
settings.rules.endTest = 10)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.