format_path: Format a path

Description Usage Arguments Value

View source: R/utils.R

Description

Normalize and validate a path (optionally, within a certain directory).

Usage

1
format_path(path, dir = NULL, mode = NA)

Arguments

path

The path to normalize.

dir

(Optional) the directory to append to the beginning of the path. NULL (default) to not append any directory, leaving path unchanged.

mode

The mode for file.access to verify existence, writing permission, or reading permission. Use NA (default) to not perform any is.

Value

The normalized path, or NULL if the path was NULL.


neuroconductor/ciftiTools documentation built on Dec. 22, 2021, 1:09 a.m.