initialise_vignette: Intitialise (onr open) an Rnw vignette.

Description Usage Arguments

View source: R/initialise-vignette.r

Description

This function creates a 'vignettes' directory and initialises an Rnw vignette template for the user to edit.

Usage

1
2
initialise_vignette(pkg = ".", title = "My Vignette",
  short_title = gsub("\\s+", "-", title), address = "", open_rnw = TRUE)

Arguments

pkg

Root directory of the package for which the vignette is going to be created. Must contain a valid DESCRIPTION file

title

Title of the vignette.

short_title

File name of the vignette.

address

The authors address.

open_rnw

Whether to open the Rnw file created for editing.


gschofl/coursedata documentation built on May 17, 2019, 8:52 a.m.