xfun (version 0.21)

relative_path: Get the relative path of a path relative a directory

Description

Given a directory, return the relative path that is relative to this directory. For example, the path foo/bar.txt relative to the directory foo/ is bar.txt, and the path /a/b/c.txt relative to /d/e/ is ../../a/b/c.txt.

Usage

relative_path(x, dir = ".", use.. = TRUE, error = TRUE)

Arguments

x

The path to be converted to a relative path.

dir

Path to a directory.

use..

Whether to use double-dots (..) in the relative path. A double-dot indicates the parent directory (starting from the directory provided by the dir argument).

error

Whether to signal an error if the path cannot be converted to a relative path.

Value

A relative path if the conversion succeeded; otherwise the original path when error = FALSE, and an error when error = TRUE.

Examples

# NOT RUN {
xfun::relative_path("foo/bar.txt", "foo/")
xfun::relative_path("foo/bar/a.txt", "foo/haha/")
xfun::relative_path(getwd())
# }