R包小插图

Question

我对为什么R包中有多个“渐晕”可能存在的位置感到困惑。我不知道哪些位置和时间使用了哪些位置。例如：

devtools::use_vignettes()

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

devtools::build_vignettes() 

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

pkgdown::build_site()

创建一个docs文件夹。

作为背景：我已经阅读了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文件的地方。

为您的用户创建小插曲

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

{pkgdown}

{pkgdown}正在使用小插图目录的Rmd文件编织html文件，以便它可以为您的软件包构建网站。它还为功能列表和自述文件中的索引建立了一个页面，该文件也用于您的git存储库。不应将其保留在R包中，并且用户不可访问。这是为了在Internet上展示您的包裹。

结论

因此，在进行开发时，您仅将Rmd小插图写入小插图目录中。其他人将自动保留他们的需求。