make_vignette_auxfiles: Generate RMarkdown Vignette Axiliary Files

View source: R/vignette.R

make_vignette_auxfilesR Documentation

Generate RMarkdown Vignette Axiliary Files

Description

Generate RMarkdown Vignette Axiliary Files

Usage

make_vignette_auxfiles(
  PACKAGE,
  input = NULL,
  bibfile = "library.bib",
  Rpkg.prefix = "Rpackage_",
  ...
)

Arguments

PACKAGE

package name

input

vignette source file. If NULL then the current file is obtained via a call to knitr::current_input.

bibfile

output file for R package citations.

Rpkg.prefix

prefix to use when generating the bibtex entries of cited R packages. If Rpkg.prefix = 'Rpackage_', then Rmardown citations should be ⁠@Rpackage_mypkg⁠.

...

other arguments passed to latex_preamble

Details

To use this feature add the following in your YAML header:

header-includes:
  - \input{"`r pkgmaker::make_vignette_auxfiles('pkgmaker')`"}
bibliography: library.bib

Value

Path to the preamble file.


pkgmaker documentation built on May 3, 2023, 5:08 p.m.