r - 我如何 'prebuild' R 包的小插图索引？

Question

我正在准备要提交给 CRAN 的包.
我用 R CMD build myPackage然后 R CMD check myPackage --as-cran它通过了所有检查，没有任何注释或警告。
但是，每次尝试提交时，我都会从其中一位 CRAN 维护人员那里收到以下错误消息:

Package has a VignetteBuilder field but no prebuilt vignette index.

首先，我希望能够在我自己的系统上重现上述错误消息 ( R version 3.0.1 )。

小插图 .Rnw文件如下所示:

%\VignetteEngine{knitr::knitr}
%\VignetteIndexEntry{myVignetteName}
\documentclass{article}
\begin{document}
Here is some code:
<<>>=
plot(1:10, 10:100)
@
\end{document}

我曾尝试添加 INDEX根目录中的文件，带有像这样的小插图条目:

myFunction       a brief description
abc-vignette     vignette description

同样，这通过了 R CMD check myPackage --as-cran但我收到相同的错误消息。

我也试过 R CMD build myPackage --md5强制创建 MD5文件，无济于事。

当我看 myPackage.Rcheck/00_pkg_src/myPackage/inst/doc我找到了小插图文件， .Rnw和 .pdf正如预期的那样。

包裹 DESCRIPTION文件有以下条目:

VignetteBuilder: knitr
Suggests: knitr

当我看 myPackage.Rcheck/myPackage/Meta我看到一个条目 vignette.rds .然而，这似乎是一个二进制文件，所以我无法理解它。

这是来自“编写 R 扩展”:

At install time an HTML index for all vignettes in the package is automatically created from the \VignetteIndexEntry statements unless a file ‘index.html’ exists in directory ‘inst/doc’. This index is linked from the HTML help index for the package. If you do supply a ‘inst/doc/index.html’ file it should contain relative links only to files under the installed ‘doc’ directory, or perhaps (not really an index) to HTML help files or to the ‘DESCRIPTION’ file.

那么我是否需要手动创建 index.html任何人都可以举一个例子来说明这应该是什么样子？

This question似乎密切相关，但我(有意)没有 .Rbuildignore文件。 This is also related ，虽然我没有使用 devtools用于包创建。我也看过 this question但我没有看到一个简单的答案。

7 月 1 日更新

对于可重现的示例，该软件包可用 here on github .下载和安装(例如使用 devtools::install_github() 应该允许重现此错误。

Answer 1

我收集了Vignette命令需要在 中序言 ，即低于 documentclass ，使文件 myVignette.Rnw应该读:

\documentclass{article}

% \VignetteIndexEntry{myVignette}
% \VignetteEngine{knitr::knitr}

\usepackage[]{graphicx}
...

这似乎工作正常。

错误消息来自 发展 R CMD check 的版本当前是 3.3.0 .我一直在使用旧的“稳定”版本，在考虑提交给 CRAN 时，这不是检查包的推荐方法。

我仍然不确定使用手册的优点 index.html文件 - 这似乎没有必要，但如果有人可以对此有所了解，我很乐意更改已接受的答案。