Skip to contents

Create Folder Templates

Source: R/create_FolderTemplates.R
create_FolderTemplates.Rd

Create file and folder structure templates on the user hard drive as expected by Generate_DataFile and Generate_DataFile_MG. Files and data in the folders must then be overwritten manually with user data. The function intends to minimise the errors going along with the creation of these folder structures. The function uses the example data of BayLum to create the templates.

Usage

create_FolderTemplates(
  path,
  mode = "SG",
  n_folders = 1,
  names = paste("Sample_", 1:n_folders),
  verbose = TRUE
)

Arguments

path

character (required): path to the folder where the templates should be created

mode

character (with default): depending on the dataset you can create templates or single grain (SG) or multi-grain (MG) data

n_folders

numeric (with default): number of template folders to be created

names

character (optional): allows give own names to the subfolders.

verbose

logical (with default): enables/disables verbose mode

Value

If the templates were created successfully on the hard drive, the function returns nothing.

Function version

0.1.0

See also

Generate_DataFile, Generate_DataFile_MG

Author

Sebastian Kreutzer, Geography & Earth Sciences, Aberystwyth University (United Kingdom)

How to cite

Kreutzer, S., 2024. create_FolderTemplates(): Create Folder Templates. 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.3.9000-13. https://CRAN.r-project.org/package=BayLum

Examples

create_FolderTemplates(tempdir())
#> 
#> [create_FolderTemplates()]
#> -|
#>  |__(dir created:) /tmp/RtmpgCzkor 
#> All templates created. Please modify the parameters according to your data!