Usage
as.sd_package(pkg = ".", site_path = NULL, examples = NULL, templates_path = NULL, bootstrap_path = NULL, mathjax = TRUE)
Arguments
- pkg
- name of package, as character vector
- site_path
- root directory in which to create documentation. The
default,
NULL
, first looks at the value of site_path
set in
DESCRIPTION, and if not found uses inst/staticdocs
.
- examples
- include examples or not? The default,
NULL
, first
looks at the value of examples
set in DESCRIPTION, and if
not found uses TRUE
.
- templates_path
- a specific directory path to use when searching for
rendering templates, in addition to the default locations of
packagedir/inst/staticdocs, packagedir/staticdocs, and the staticdocs
package's included templates directory.
- bootstrap_path
- a specific directory path to use when searching for
bootstrap style files, in addition to the default locations of
packagedir/inst/staticdocs, packagedir/staticdocs, and the staticdocs
package's included bootstrap directory.
- mathjax
- whether to use mathjax to render math symbols.
Value
A named list of useful metadata about a package
Description
Return information about a package