Skip to contents

Path to Artalytics Workspace for Local Development

Source: R/path-artd.R
path_artd.Rd

Returns the path to the Artalytics workspace directory for use in local development. The function automatically detects the operating system and looks up the appropriate environment variable to locate the workspace.

Usage

path_artd()

Value

Character string containing the absolute path to the Artalytics workspace directory.

Details

The function determines the correct environment variable based on the operating system:

  • Windows: ARTD_HOME

  • Linux: ARTD_HOME_WSL

  • macOS (Darwin): ARTD_HOME_MAC

The function validates that:

  1. The environment variable is set (non-empty string)

  2. The path specified by the environment variable exists on the filesystem

If either validation fails, an error is raised with a descriptive message.

See also

Other dev-utils: describe_env(), dev-helpers, get_repo_index(), list_art_packages(), ls-docs

Examples

if (FALSE) { # \dontrun{
# Get the Artalytics workspace path
workspace_path <- path_artd()
print(workspace_path)

# Use the path to access workspace files
data_path <- file.path(path_artd(), "data", "myfile.csv")
} # }