File paths relative to the root of a directory hierarchy
Source:R/file.R
, R/shortcut.R
find_root_file.Rd
find_root_file()
is a wrapper around find_root()
that
appends an arbitrary number of path components to the root using
base::file.path()
.
Usage
find_root_file(..., criterion, path = ".")
find_rstudio_root_file(..., path = ".")
find_package_root_file(..., path = ".")
find_remake_root_file(..., path = ".")
find_testthat_root_file(..., path = ".")
Arguments
- ...
[character]
Further path components passed tofile.path()
. All arguments must be the same length or length one.- criterion
[root_criterion]
A criterion, one of the predefined criteria or created byroot_criterion()
. Will be coerced usingas_root_criterion()
.- path
[character(1)]
The start directory.
Value
The normalized path of the root as specified by the search criteria, with the additional path components appended. Throws an error if no root is found.
Details
This function operates on the notion of relative paths.
The ...
argument is expected to contain a path relative to the root.
If the first path component passed to ...
is already an absolute path,
the criterion
and path
arguments are ignored,
and ...
is forwarded to file.path()
.