set_sourcoise_root: Set the Root Directory for Sourcoise

In sourcoise: Source a Script and Cache

Set the Root Directory for Sourcoise

Description

This function allows you to manually set the root directory for the sourcoise package, bypassing the automatic root detection mechanism used by sourcoise(). Setting the root directory affects where sourcoise looks for files and stores cache data.

Usage

set_sourcoise_root(root = NULL, quiet = TRUE)

Arguments

root	Path to the desired root directory. If NULL (default), sourcoise will attempt to automatically detect the project root. Can be an absolute or relative path.
quiet	Logical value indicating whether to suppress messages during root detection. Default is TRUE (messages suppressed).

Details

By default, sourcoise automatically detects the project root. This function is equivalent to setting the sourcoise.root option directly, except when dealing with file-level cache storage. To enable file-level cache storage behavior, set root to NULL.

Value

The root path that was set (character string), invisibly returned by try_find_root().

Examples

# Set root to a temporary directory
dir <- tempdir()
set_sourcoise_root(dir)

# Reset to automatic detection
set_sourcoise_root(NULL)

# Set root with messages enabled
set_sourcoise_root(dir, quiet = FALSE)

sourcoise documentation built on Jan. 8, 2026, 1:07 a.m.