Skip to contents

Sets the results folder in the project environment. Creates a date-based subfolder. You reach the date-based folder at proj$results_today. set_results() automatically cleans up empty date folders when new results are added.

Usage

set_results(results, proj = org::project)

Arguments

results

A character vector specifying one or more possible results folder paths. set_results() uses the first existing path.

proj

The project environment. Default is org::project.

Value

Nothing. Modifies the proj environment to include:

$results

The base results folder path.

$results_today

Path to today's results folder. The format is YYYY-MM-DD.

See also

vignette("org"), whose "Common workflows" section shows when to change the results folder after a project is already initialized.

Other project setup: initialize_project(), project

Examples

home <- file.path(tempdir(), "org_set_results_example")
dir.create(file.path(home, "R"), recursive = TRUE, showWarnings = FALSE)

proj <- org::initialize_project(
  home = home,
  results = file.path(home, "results_a")
)
#> You are NOT sourcing into .GlobalEnv. All functions will be sourced into an environment that is returned from this function.
#> Sourcing all code inside /tmp/RtmppZAjz6/org_set_results_example/R into 
org::project$results_today
#> [1] "/tmp/RtmppZAjz6/org_set_results_example/results_a/2026-08-21/"

# Point the project at a different results folder
org::set_results(file.path(home, "results_b"))
org::project$results_today
#> [1] "/tmp/RtmppZAjz6/org_set_results_example/results_b/2026-08-21/"
dir.exists(org::project$results_today)
#> [1] TRUE

unlink(home, recursive = TRUE)