buildDocs: Title

Description Usage Arguments

Description

Description

Usage

1
2
3
buildDocs(docsLoc, outLoc = NULL, pageList = NULL, navPill = "",
  editHref = "", copyrightText, windowTitle = NULL, root.dir = NULL,
  knit = TRUE, purl = TRUE)

Arguments

docsLoc

base directory of the .Rmd files

outLoc

base directory where output .html, assets, code, figures should go

pageList

optional vector of file paths to be included in the document build, in the order in which they are provided, relative to docsLoc - this is useful if they aren't already in order

navPill

HTML to go in the nav-pill (see packagePills)

editHref

link to URL where the file can be edited (used with github)

copyrightText

text to go with copyright

windowTitle

optional title for the window

root.dir

passed to opts_knit$set()

knitr

should the document be typeset?

purl

should code be pulled out and put in the code directory?


hafen/buildDocs documentation built on May 17, 2019, 1:32 p.m.