create_results_dir_path: Create results directory path

In tece-lab/DAISIEutils: Utility Functions for the DAISIE Package

Create results directory path

Description

Create results directory path

Usage

create_results_dir_path(data_name, results_dir = NULL)

Arguments

data_name

String. Will be used for the name of the created output folder.

results_dir

A string with the path to the directory where results are to be stored or can be found. For example, if the data in question is (to be) stored in ⁠folder_with_res/$data_name⁠, then results_dir should be "folder_with_res". Defaults to NULL, which indicates the default directories are to be used. Default directories are: * ⁠$HOME/results/$data_name⁠ if on the cluster * ⁠getwd()/results/$data_name⁠ if called from another environment If is.na(results_dir), then the object is returned to the R session and not saved to file.

Value

String with platform appropriate file path to be used for the results directory for a given data set.

Author(s)

Pedro Santos Neves

Examples

results_dir_path <- create_results_dir_path(data_name = "Azores")

tece-lab/DAISIEutils documentation built on Jan. 31, 2024, 12:09 p.m.