checkVignette: Check an '.Rmd' file that will be included in bookdown

Description Usage Arguments Details

View source: R/checkVignette.R

Description

Bookdown markdown headers are special in that each chapter *must* start with a first-level header '#'.

Usage

1
checkVignette(rmdfiles)

Arguments

rmdfiles

character() path to a (set of) '.Rmd' file(s)

Details

A common workflow is to have each "chapter" respresented as a single '.Rmd' file. Functions to check and then fix '.Rmd' files programmatically facilitate finding and fixing vignettes that do not meet these criteria.


seandavi/BiocWorkshopPackageTest documentation built on Aug. 21, 2019, 8:58 p.m.