[R-pkg-devel] Correct way to set title for vignette?

Dirk Eddelbuettel edd @ending from debi@n@org
Tue Jul 24 19:02:25 CEST 2018

On 24 July 2018 at 16:46, Martin Møller Skarbiniks Pedersen wrote:
| Hi,
|   Some vignettes on Cran has the title: "Title of your vignette"
|   Eg.  https://cran.r-project.org/package=ggpval
| The source for the vignette at
| "https://raw.githubusercontent.com/s6juncheng/ggpval/master/vignettes/ggpval.Rmd
| but is this the correct file to set the title?
| I think ggpval.Rmd is generated from another file?

It is the 'VignetteIndexEntry' line:

  title: "ggpval user guide"
  author: "Jun Cheng"
  date: "`r Sys.Date()`"
  output: rmarkdown::html_vignette
  vignette: >
    %\VignetteIndexEntry{Title of your vignette}

Just put 'ggpval User Guide' (or something like it) there.

Hth, Dirk

http://dirk.eddelbuettel.com | @eddelbuettel | edd using debian.org

More information about the R-package-devel mailing list