By default, pkgdown will generate an index that lists all functions in
alphabetical order. To override this, provide a
reference section in your
_pkgdown.yml as described below.
build_reference(pkg = ".", lazy = TRUE, document = FALSE, examples = TRUE, run_dont_run = FALSE, mathjax = TRUE, seed = 1014, override = list(), preview = NA) build_reference_index(pkg = ".")
Path to package.
Run examples that are surrounded in \dontrun?
Use mathjax to render math symbols?
Seed used to initialize so that random examples are reproducible.
An optional named list used to temporarily override
To tweak the index page, add a section called
which provides a list of sections containing, a
title, list of
and an optional
For example, the following code breaks up the functions in pkgdown into two groups:
reference: - title: Render components desc: Build each component of the site. contents: - starts_with("build_") - init_site - title: Templates contents: - render_page
contents can contain either a list of function names, or if the
functions in a section share a common prefix or suffix, you can use
ends_with("suffix") to select them all. For
more complex naming schemes you can use an arbitrary regular expression with
matches("regexp"). You can also use a leading
- to exclude matches from a
section. By default, these functions that match multiple topics will exclude
topics with the Rd keyword "internal". To include these, use
starts_with("build_", internal = TRUE).
You can alo select topics that contain specified Rd concepts with
You can provide long descriptions for groups of functions using the YAML
desc: > This is a very long and overly flowery description of a single simple function.
If you have functions with odd names (e.g. that start with a plus symbol
+), you can include them by double-escaping. This YAML entry adds the
+.gg function to the ggplot2 documentation:
pkgdown will check that all non-internal topics are included on this page, and will generate a warning if you have missed any.
You can control the default rendering of figures by specifying the
_pkgdown.yml. The default settings are equivalent to:
figures: dev: grDevices::png dpi: 96 dev.args:  fig.ext: png fig.width: 7.2916667 fig.height: ~ fig.retina: 2 fig.asp: 1.618
You can optionally supply an icon for each help topic. To do so, you'll need
icons directory. This should contain .png files that are
either 30x30 (for regular display) or 60x60 (if you want retina display).
Icons are matched to topics by aliases.