从R包中的手册链接到小插图的最佳方法 [英] best way to link to a vignette from manual in an R package

问题描述

我正在开发R程序包，并尝试从该程序包的手册链接到其插图（pdf）。我已经在R函数代码中做到了，它可以正常工作：

I'm developing an R package, and I'm trying to make a link from the manual of the package to its vignette (a pdf). I've make this in the R function code, and it works:

\link[=../doc/package.pdf]{package's User Manual}

问题是devtools :: check（）抱怨警告，这还会在上传到CRAN时导致修订过程的延迟...

The problem is that the devtools::check() complains with a warning, which also causes a delay in the process of revision when uploading to CRAN...

* checking Rd cross-references ... WARNING   
Missing link or links in documentation object 'package.Rd':   
'../doc/package.pdf'

有没有更好的方式将人与小插图联系起来？还是这样做不正确？由于pdf可以包含更多图形信息，因此似乎希望能够链接到它。

Is there a better way of linking from man to vignette? or it is not correct to do so? As the pdf can contain more graphical information, it seems desirable to be able to link to it.

推荐答案

如果使用pkgdown来从您的包裹中创建一个网站，然后您可以直接链接到特定插图的网址。

If you use pkgdown to make a website out of your package, then you can directly link to the url of the specific vignette.

或者您可以只写

运行\code {vignette（ NAME_OF_YOUR_VIGNETTE，package = NAME_OF_YOUR_PACKAGE）}以查看相应的小插图。

Run \code{vignette("NAME_OF_YOUR_VIGNETTE", package = "NAME_OF_YOUR_PACKAGE")} to see the corresponding vignette.

这篇关于从R包中的手册链接到小插图的最佳方法的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！