check_directories: Check directory input

View source: R/input-check.R

check_directoriesR Documentation

Check directory input

Description

Check directory input

Usage

check_directories(
  directories,
  ref = NULL,
  type = "folders",
  fdb.fn = "stop",
  with.time = FALSE,
  verbose = TRUE
)

Arguments

directories

Character vector. Directories to check.

ref

Character value. Input reference for the error message. If set to NULL the value of x is evaluated via non standard evalulation.

type

Character value. One of 'files', 'folders', 'create_files'. Checks whether the given directories lead to the specified type or are creatable.

fdb.fn

Character value. Determines the function to call if a feedback message needs to be given. One of 'stop', 'warning' or 'message'.

with.time

Logical value. Indicates whether the current time is to be added to the feedback message.

verbose

Logical value. Indicates whether any kind of feedback is supposed to be given. verbose set to FALSE shuts down any error, warning or general messages and results in the functions returning what is specified in return.

Value

An informative error message or an invisible TRUE.


kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.