R Markdown を使用して R パッケージ ビネットを作成しようとしています。R Studio のパッケージ オーサリング ツールを使用しています。
バージョン 3.0 以上の R を使用しています。
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 を自動的に作成させるにはどうすればよいですか?
Markdown を使用した R Package Vignettes に関する Yihui の投稿を読んだところ、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")