0

我正在构建一个 R 包。我有几个小插曲，我想在我的 README.Rmd 中包含指向它们的链接。

我知道在安装软件包时可以选择构建小插图。

我真的不明白我应该从哪里开始。我正在 R Studio 中构建包。我希望用户能够通过单击 GitHub 上自述文件中的链接来查看小插图。这可能吗？如何？

以下显然不起作用。

[The main vignette](vignettes/Vignette.html)
4

1 回答 1

1

你可以这样做，但它可能比它的价值更麻烦。

问题是

  1. Vignette.html您的包目录在 Github 上的源代码中与您在 R 中安装包时的目录不同。如果您实际放入目录中，您提供的链接会很好vignettes，但是当您的包安装时，它将位于doc.

  2. 如果您只是 knit ，RStudio 默认不会将处理后的小插图放在这些位置中的任何一个位置Vignette.Rmd。

  3. 您通常不会在 Github 上提交输出文件。

因此，您可以采取以下措施来解决此问题。使链接看起来像

[The main vignette](doc/Vignette.html)

为了确保该文件在 Github 上，在 RStudio 中创建doc目录并运行

rmarkdown::render("vignettes/Vignette.Rmd", output_file="doc/Vignette.html")

您需要提交输出文件并将其推送到 Github，但您不想在构建.tar.gz文件时包含它，因此您还需要添加这些行

^doc$
^doc/Vignette.html$

到.Rbuildignore主包目录中的文件。

通过所有这些更改，我认为您的小插图将在 Github 上以及在 R 中安装软件包之后可见。

一个更简单的方法是告诉用户运行

vignette("Vignette", package = "yourpackagename")

安装软件包后，但这不会使其在 Github 上可见。

于 2019-09-01T15:38:14.473 回答