cloneWorkspace: Clone template workspace

View source: R/cloneWorkspace.R

cloneWorkspaceR Documentation

Clone template workspace

Description

This function makes your own copy of the existing workspace, selected through templateName or analysis. Your copied/cloned workspace name will be workspaceName and any computing cost will be charaged to the billing linked to your billingProjectName. You should provide at least one argument templateName or analysis.

Usage

cloneWorkspace(
  workspaceName,
  templateName = "",
  analysis = NULL,
  bucketLocation = "us-central1",
  accountEmail = gcloud_account(),
  billingProjectName = gcloud_project()
)

Arguments

workspaceName

Name of the workspace you are creating

templateName

Character(1). Name of the template workspace name you want to clone. You can provide name or namespace/name.

analysis

Character(1). Name of the analysis you want to clone it's workspace. The list of available analyses can be found using availableAnalysis.

bucketLocation

Character(1). Region in which bucket attached to the workspace should be created. Default is us-central1. For multi-region, enter US.

accountEmail

Character(1). Email linked to Terra account

billingProjectName

Character(1). Name of the billing project

Value

Name of the cloned workspace

Examples

library(AnVILBase)
if (
    gcloud_exists() && identical(avplatform_namespace(), "AnVILGCP") &&
    nzchar(avworkspace_name())
) {
cloneWorkspace(workspaceName = "salmon",
               templateName = "Bioconductor-Workflow-DESeq2")
}
 

shbrief/RunTerraWorkflow documentation built on Oct. 9, 2024, noon