orderly_location_rename: Rename a location

In orderly: Lightweight Reproducible Reporting

Rename a location

Description

Rename an existing location

Usage

orderly_location_rename(old, new, root = NULL)

Arguments

old	The current short name of the location. Cannot rename local or orphan
new	The desired short name of the location. Cannot be one of local or orphan
root	The path to the root directory, or NULL (the default) to search for one from the current working directory. This function does not require that the directory is configured for orderly, and can be any outpack root (see orderly_init() for details).

Value

Nothing

Examples

# Two roots, one local and one representing some remote orderly location:
local <- orderly_example()
remote <- orderly_example()
orderly_location_add_path("remote", remote, root = local)

orderly_location_list(root = local, verbose = TRUE)

# Rename the remote location:
orderly_location_rename("remote", "bob", root = local)
orderly_location_list(root = local, verbose = TRUE)

orderly documentation built on Jan. 24, 2026, 1:07 a.m.