Use Codespace — use_codespace • rworkflows

Generate a dev container config file to set up a GitHub Codespace.

use_codespace(
  template = "devcontainer.json",
  image = "ghcr.io/neurogenomics/rworkflows:dev",
  features = list(`ghcr.io/devcontainers/features/conda:1` = list()),
  customizations = list(vscode = list(settings = list(), extensions =
    list("reditorsupport.r", "visualstudioexptteam.vscodeintellicode",
    "ionutvmi.path-autocomplete"))),
  save_dir = here::here(".devcontainer"),
  path = file.path(save_dir, template),
  force_new = FALSE,
  show = FALSE,
  verbose = TRUE
)

Arguments

template: Dev container config template to use.
image: Base Docker image to use for the Codespace.
features: Named list of features to add to the Codespace. See here for details.
customizations: Named list of customizations to add to the Codespace. See here for details.
save_dir: Directory to save the file to.
path: Path to the file.
force_new: If the file already exists, overwrite it (default: FALSE).
show: Print the contents of the file in the R console.
verbose: Print messages.

Value

Path to dev container config file.

Examples

path <- use_codespace(save_dir=tempdir())
#> Creating new dev container config file ==> /tmp/RtmpT6qXye/devcontainer.json