use_dockerfile: Add a Dockerfile

View source: R/core_use_dockerfile.R

use_dockerfileR Documentation

Add a Dockerfile

Description

This will create a basic ‘Dockerfile’ based on rocker/verse

Usage

use_dockerfile(
  pkg = ".",
  rocker = "verse",
  qmd_to_knit = "path_to_qmd",
  use_gh_action = TRUE
)

Arguments

pkg

defaults to the package in the current working directory

rocker

chr, the rocker image to base this container on

qmd_to_knit

chr, path to the qmd file to render in the Docker container, relative to the top level of the compendium (i.e. "analysis/paper/paper.qmd"). There's no need to specify this if your qmd to render is at "analysis/paper/paper.qmd", "vignettes/paper/paper.qmd" or "inst/paper/paper.qmd". If you have a custom directory structure, and a custom file name for the qmd file, you can specify that file path and name here so Docker can find the file to render in the container.B

use_gh_action

lgl, create a configuration figure to activate GitHub Actions continuous integration? Uses the Dockerfile to generate a Docker container, and renders the qmd file in that.


benmarwick/rrtools documentation built on March 18, 2024, 2:22 a.m.