as_workspace: Render R packages as AnVIL workspaces

Description Usage Arguments Details Value

View source: R/as_workspace.R

Description

as_workspace() renders a package source tree (e.g., from a git checkout) as an AnVIL workspace.

Usage

1
as_workspace(path, namespace, name = NULL, create = FALSE, update = FALSE)

Arguments

path

character(1) path to the location of the package source code.

namespace

character(1) AnVIL namespace (billing project) to be used.

name

character(1) AnVIL workspace name or NULL. If NULL, the workspace name is set to "Bioconductor-Package-<pkgname>", where <pkgname> is the name of the package (from the DESCRIPTION file) at path.

create

logical(1) Create a new project?

update

logical(1) Update (over-write the existing DASHBOARD and any similarly named notebooks) an existing workspace? If niether create nore update is TRUE, the code to create a workspace is run but no output generated; this can be useful during debugging.

Details

Information from the DESCRIPTION file and Rmd YAML files are used to populate the 'DASHBOARD' tab.

1
2
See `?as_notebook()` for details on how vignettes are processed
to notebooks, and the limitations of the current approach.

Value

as_workspace() returns the URL of the updated workspace, invisibly.


AnVILPublish documentation built on Nov. 8, 2020, 5:10 p.m.