new_vignette. reports 0.2.0

Usage

new_vignette(vignette = "vignette", type = "rmd", path = getwd(), bib.loc = NULL, 
  name = getOption("name.reports"), open = is.global(2), github = FALSE)

append_vignette(vignette = "vignette", type = "rmd", path = getwd(), bib.loc = NULL, 
      name = getOption("name.reports"))

Arguments

vignette: A character string of the vignette name (subdirectories of the main directory, "vignettes", will utilize this string). The function append_vignette will create an additional vignette with this name in the vignettes directory.
type: A character string of either "rmd" or "rnw".
path: The path to where the project should be created. Default is the current working directory. Suggest setting to the package root directory. If using the function append_vignette this is the path to the current vignettes directory.
bib.loc: Optional path to a .bib resource.
name: A character string of the user's name to be used on the vignette.
open: logical. If TRUE the project will be opened in RStudio. The default is to test if new_vignette is being used in the global environment, if it is then the project directory will be opened.
github: logical. If TRUE the repo will be sent to public GitHub account.

Value

Creates a vignette template.

Description

new_vignette - Generate a vignettes template to increase efficiency.

append_vignette - Add vignettes to a pre-existing vignettes directory.

Suggestion

The user may want to set options for bib.loc, name.reports in the user's primary .Rprofile:

bib.loc - The path to the users primary bibliography
name.reports - The name to use on reports

References

http://yihui.name/knitr/demo/vignette/

http://cran.r-project.org/doc/manuals/r-devel/R-exts.html#Writing-package-vignettes

Examples

## new_vignette()

Vignette Template