tnu_workspace: Manage workspace namespace and name needed by...

In vjcitn/BiocTNU: Interface to terra-notebook-utils

Manage workspace namespace and name needed by terra-notebook-utils

Description

tnu_workspace() gets (when x = NULL) or sets and returns the namespace and name in the form NAMESPACE/NAME.

tnu_workspace_ok() returns TRUE when the workspace namespace and name have been set by tnu_workspace(), package options, or system environment variables.

Usage

tnu_workspace(x = NULL, is_google_cloud = TRUE)

tnu_workspace_ok()

Arguments

x	NULL (get the existing value) or character(1) workspace namespace and name, formatted as NAMESPACE/NAME.
is_google_cloud	logical(1) is the workspace on the google cloud? If so, ensure that the environment variable WORKSPACE_BUCKET is set, as this is used by terra-notebook-utils during authentication.

Details

tnu_workspace() with no argument checks to see if the workspace namespace and name have been assigned through a previous call to tnu_workspace(), or are defined by the package options AnVILTNU.WORKSPACE_NAMESPACE, AnVILTNU.WORKSPACE_NAME (set via options(AnVILTNU.WORKSPACE_NAME = ...)), or by the system environment variables WORKSPACE_NAMESPACE, WORKSPACE_NAME. Calls to tnu_workspace() have precedence over package options, which have precedence over system environment variables.

Examples

if (tnu_workspace_ok()) {
    tnu_workspace()
}

tnu_workspace_ok()

vjcitn/BiocTNU documentation built on July 28, 2023, 8:09 p.m.