as_workspace: Render R packages as AnVIL workspaces

In Bioconductor/AnVILPublish: Publish Packages and Other Resources to AnVIL Workspaces

Render R packages as AnVIL workspaces

Description

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

Usage

as_workspace(
  path,
  namespace,
  name = NULL,
  create = FALSE,
  update = FALSE,
  use_readme = FALSE,
  type = c("ipynb", "rmd", "both"),
  quarto = c("render", "convert")
)

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.
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 neither create nor update is TRUE, the code to create a workspace is run but no output generated; this can be useful during debugging.
use_readme	logical(1) Defaults to FALSE; if TRUE the content of README.md in package top-level folder is used with the package DESCRIPTION version and provenance metadata for rendering in the workspace 'DASHBOARD'.
type	character(1) The type of notebook to be copied to the workspace. Must be on of ipynb, rmd, or both. ipynb copies only the Jupyter notebook. rmd copies Rmarkdown and Quarto vignettes. both copies both notebooks and vignettes.
quarto	character(1) If the program Quarto is installed, this parameter indicates whether the .Rmd files will be rendered or converted. See vignette for more details.

Details

Information from the DESCRIPTION file and Rmd YAML are used to populate the 'DASHBOARD' tab. See ?as_notebook() for details on how vignettes are processed to notebooks.

Value

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

Bioconductor/AnVILPublish documentation built on Nov. 2, 2024, 1:41 p.m.