Skip to contents

When pointed at the root directory of an R Package Project, this function will automatically generate and render a Quarto/Revealjs presentation for that package. It will have a title slide and description slide generated from the package's DESCRIPTION file and each exported function will have slides with its description and returns, parameters, examples, and source code.

Usage

build_presentation(package = getwd(), file = NULL, yaml = create_yaml())

Arguments

package

A file path to the root directory of an R package source folder, the name of an R package from CRAN, or an R package from GitHub in the username/repository format.

file

The file name for your .qmd file. This can be a path so long as it ends with a `file_name.qmd`

yaml

A `_pkgslides.yml` file or function call to `create_yaml()`

Value

This function creates and renders a .qmd presentation but does not return an R object.