r - 从 R 包中的手册链接到小插图的最佳方法

Question

我正在开发一个 R 包，我正在尝试建立从包手册到它的小插图(pdf)的链接。我在 R 函数代码中做了这个，它有效:

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

问题是 devtools::check() 报错警告，这也导致上传到 CRAN 时修改过程延迟...

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

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

Answer 1

如果你使用 pkgdown 从你的包中创建一个网站，那么你可以直接链接到特定 vignette 的 url。

或者你可以直接写

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