scratch_dir: Set the scratch directory for vmeasur

Description Usage Arguments Details Value Examples

View source: R/utility_functions.R

Description

vmeasur uses av to unpack temporary image files, which are then stored for further usage. This runs better if done to a high speed storage location such as a ram drive. This function sets that directory, and provides other options for specifying the structure of this temporary data.

Usage

1
2
3
4
5
6
scratch_dir(
  set = NULL,
  random_subfolder = FALSE,
  file_name = FALSE,
  wipe_scratch = FALSE
)

Arguments

set

new directory to set. If left blank, no directory change will occur

random_subfolder

Should a random sub folder be created

file_name

Specify the name of the directory

wipe_scratch

Should the folder be cleared before use

Details

If not specified, the default R tempdir is used

Value

the current location of the scratch directory

Examples

1
2

vmeasur documentation built on Nov. 12, 2021, 1:07 a.m.