Writes the reference pages and index as Quarto files

write_reference

Description

Writes the reference pages and index as Quarto files

Usage

write_reference(
  project = ".",
  pkg = NULL,
  folder = NULL,
  examples = TRUE,
  not_run_examples = NULL,
  template = NULL,
  index_file = NULL,
  index_template = NULL
)

Arguments

Arguments	Description
project	The path to the root folder of the project.
pkg	The path inside the project folder. Use only if the R package itself is in a sub-folder within the project.
folder	The target folder to save the new Quarto files to
examples	Flag that sets the examples code chuck to be evaluated when the Quarto document is rendered
not_run_examples	Flag that sets the “do not run” examples code chuck to be evaluated when the Quarto document is rendered
template	The path to a Quarto file that can be used as the template for all of the resulting reference files. If left NULL, pkgsite will use its default template.
index_file	The name assigned to the resulting index Quarto file
index_template	The path to a Quarto file that can be used as the template for the index Quarto file

Value

A set of Quarto files written to the specified path based on the number of Rd files in the package, plus an additional one that is the index.

See Also

Other Quarto file creation: write_reference_index(), write_reference_pages()