Link 到 readme.rda 的小插图

Link to vignette from readme.rda

我正在构建一个 R 包。我有几个小插图，我想在我的 README.Rmd 中包含 links。

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

我不太明白我应该从哪里开始。我正在 R studio 中构建包。我希望用户只需单击 GitHub 自述文件中的 link 即可看到小插图。这可能吗？怎么样？

下面的显然不行。 

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

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

问题是

  1. 你的包目录在 Github 上的源代码中与你的包安装在 R 中时不同。你提供的 link 如果你真的把Vignette.html 在 vignettes 目录中，但是当你的包安装时，它会在 doc 中。

  2. 如果您只是编织 Vignette.Rmd.

    3. ，默认情况下，RStudio 不会将处理过的插图放在这两个位置中的任何一个

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

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

[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 上可见。