R 包小插图

Question

我对为什么 R 包中的“小插曲”有多个可能的位置感到有点困惑。我不明白哪些位置用于什么时间。例如:

devtools::use_vignettes()

在包的根目录下创建一个 vignettes 文件夹

devtools::build_vignettes() 

创建一个 inst/doc 文件夹，在构建时提升到根目录

pkgdown::build_site()

创建一个文档文件夹。

作为背景:我已经阅读了 H.Wickhams R 包书，并且我已经使用第一个选项创建了几个包并且所有的东西都表现良好。我会让用户使用以下方法从 github 安装:

devtools::install_github(pkg,build_vignettes=TRUE)

现在，我刚刚开始参与联合开发一个包，其中使用了第一个和第三个选项。我注意到 vignettes 文件夹中的 .rmd 文件与 docs 文件夹中的 index.html 文件相同。 pkgdown 是否从 vignettes 文件夹复制？

同样对于这个包，当我从 github 安装时(使用 build_vignettes=TRUE)我得到一个错误说安装失败因为找不到 doc/index.html 路径。为什么会发生这种情况？

Answer 1

小插曲开发

只有一个地方可以放置原始插图，它位于根目录的插图目录中。这是您在开发包时使用文本和代码示例编写 Rmd 文件的地方。

为您的用户构建小插曲

当你构建你的 vignettes 时，Rmd 文件将被编织。生成的 html 文件、原始 Rmd 文件和提取的 R 代码将三个文件保存在 inst/doc 目录中。这是将保留在软件包安装中的内容。这是用户将能够阅读的内容。

{pkgdown}

{pkgdown} 正在使用 vignette 目录的 Rmd 文件来编织 html 文件，以便它可以为您的包构建一个网站。它还为函数列表构建一个页面，并从自述文件中创建一个索引，该文件也用于您的 git 存储库。这不应该保留在 R 包中，用户无法访问。这是为了在 Internet 上展示您的包裹。

结论

因此，当您进行开发时，您只需在 vignette 目录中编写 Rmd vignette。其他人会自动保留他们需要的东西。