从readme.rda链接到vignette

Question

我正在建造一个R包。我有几个小插曲，我想包括在我的README.Rmd链接。

我知道在安装这个软件包时，可以选择安装小插画。

我真的不明白我应该从哪里开始。我正在R演播室里建造这个包。我希望用户只需点击GitHub上自述文件中的链接就能看到小片段。这个是可能的吗？多么?

以下内容显然不起作用。

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

Answer 1

你可以这样做，但这可能是更多的麻烦，这是值得的。

问题是

1. 您的包目录在Github上的源代码中与您的包安装在R中时是不同的。如果您实际上将Vignette.html放在vignettes目录中，那么您所提供的链接就会很好，但是当您的包安装时，它将位于doc中。
2. 如果您只是编织RStudio，那么在默认情况下，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文件。

有了所有这些变化，我认为您的vignette在Github上将是可见的，在您将软件包安装在R中之后也是如此。

一个简单得多的方法就是告诉用户运行

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

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