我正在尝试使用 R Markdown 编写 R Package vignettes。我正在使用 R Studio 的包创作工具。
我的 R 大于 3.0 版。
我在vignettes
文件夹中有一个 .Rmd 文件,顶部包含以下文本:
<!--
%\VignetteEngine{knitr::knitr}
%\VignetteIndexEntry{An Introduction to the bootcorrelations package}
-->
我的DESCRIPTION
文件中有以下内容:
VignetteBuilder: knitr
Suggests: knitr
当我在 RStudio 中清理和构建或构建和重新加载包时,会显示小插图源,但不会显示 HTML(即,在 中没有 HTML 文件inst/man
)。
如何让 RStudio 从 R Markdown Vignette 自动创建 HTML?
我已经阅读了Yihui 关于 R Package Vignettes with Markdown 的帖子,它建议使用 makefile,但是这个关于 knitr vignettes的最新文档表明不再需要 makefile。
我也意识到我可以使用如下命令手动创建 HTML 小插图:
library(knitr)
knit(input='vignettes/foo.Rmd', output='inst/doc/foo.md')
library(markdown)
markdownToHTML('inst/doc/foo.md', 'inst/doc/foo.html')
一个可重现的例子:
Vectorize(dir.create)(c("test", "test/R", "test/man", "test/vignettes"))
cat(
'Package: test
Title: Test pkg
Description: Investigate how to auto-compile markdown vignettes
Version: 0.0-1
Date: 2015-03-15
Author: Jeromy Anglim
Maintainer: Jeromy Anglim <a@b.com>
Suggests: knitr
License: Unlimited
VignetteBuilder: knitr',
file = "test/DESCRIPTION"
)
cat(
'---
title: "Introduction"
author: "Jeromy Anglim"
date: "`r Sys.Date()`"
output: html_document
---
<!--
%\\VignetteEngine{knitr::rmarkdown}
%\\VignetteIndexEntry{Introduction}
-->
# Introduction
A sample vignette!
```{r}
1 + 1
```',
file = "test/vignettes/intro.Rmd"
)
cat(
"#' Nothing
#' This function is only needed so that roxygen generates a NAMESPACE file.
#' @export
nothing <- function() 0",
file = "test/R/nothing.R"
)
library(roxygen2)
library(devtools)
roxygenise("test")
build("test")