cas_get_base_folder: Get base folder under which files will be stored.

In giocomai/castarter: Content Analysis Starter Toolkit

Get base folder under which files will be stored.

Description

The path is computed based on inputs and settings; it may or may not exist.

Usage

cas_get_base_folder(
  ...,
  level = c("base", "project", "website"),
  custom_path = NULL
)

Arguments

...	Passed to cas_get_options().
level	Defaults to "base". Valid values are "website", "project", and "base".
custom_path	Defaults to NULL. If given, all other parameters and settings are ignored, and this value is returned.

Value

Path to the folder well all project files are stored.

Examples

cas_set_options(
  base_folder = fs::path(tempdir(), "R", "castarter_data"),
  db_folder = fs::path(tempdir(), "R", "castarter_data"),
  project = "example_project",
  website = "example_website"
)

cas_get_base_folder()

cas_get_base_folder(level = "website")
cas_get_base_folder(level = "project")
cas_get_base_folder(level = "base")

cas_get_base_folder(custom_path = fs::path(tempdir(), "custom_path"))

giocomai/castarter documentation built on June 12, 2025, 8:49 p.m.