relative_path: Calculate path relative to a reference directory

View source: R/relative_path.R

relative_pathR Documentation

Calculate path relative to a reference directory

Description

After normalizing both file and dir, try to find a common ancestor directory to build a path for file relative to dir.

Usage

relative_path(file, dir = getwd())

Arguments

file

A single string with the path to a file or directory to transform as relative.

dir

A single string with the "reference" directory (by default, the directory provided by getwd().

Value

A single character string with the relative path, or file unmodified if file is totally unrelated to dir.

Author(s)

Philippe Grosjean phgrosjean@sciviews.org

See Also

getwd(), normalizePath()

Examples

relative_path("/Users/me/project/file.txt", "/Users/me/project")
relative_path("/Users/me/project/subdir/file.txt", "/Users/me/project")
relative_path("/Users/me/file.txt", "/Users/me/project")
relative_path("/Users/me/subdir/file.txt", "/Users/me/project")
relative_path("/Users/file.txt", "/Users/me/project")
relative_path("/Users/subdir1/subdir2/file.txt", "/Users/me/project")
relative_path("/Unrelated/file.txt", "/Users/me/project")

relative_path("file.txt", "/Users/me/project")
relative_path("~/file.txt", "/Users/me/project")
relative_path("./file.txt", "/Users/me/project")
relative_path(file.path(getwd(), "data.io", "file.txt"))


SciViews/data.io documentation built on May 5, 2024, 1:39 p.m.