build_workshops: Render workshops

Description Usage Arguments

View source: R/build_workshops.R

Description

Render the workshops and download the source files if requested.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
build_workshops(
  path = ".",
  download = FALSE,
  id = NULL,
  lang = c("both", "en", "fr"),
  Rmdfiles = NULL,
  update_template = FALSE,
  pdf = FALSE,
  script = FALSE,
  upgrade = "never",
  verbose = TRUE
)

Arguments

path

path where the workshops files are or a path to a folder where the files will be extracted if download is set to TRUE.

download

a logical. Should the workshop source files be downloaded? Default set to FALSE, it TRUE then id must be specified.

id

workshops identifier.

lang

language of workshop, either "both" (default), "en" (English) or "fr" (French).

Rmdfiles

R Markdown source files, if NULL (default) then, files will be searched for in the current directory.

update_template

a logical. Should the template files be updated. Note that if these files are missing then they will be downloaded.

pdf

a logical. Should a pdf version of the template be produced?

script

a logical. Should the R script be extracted?

upgrade

One of "default", "ask", "always", or "never". "default", see remotes::install_deps() for further details.

verbose

a logical. Should extra information be reported on progress?


QCBSRworkshops/qcbsRworkshops documentation built on Nov. 18, 2020, 11:32 p.m.