Link 从帮助页面和 pkgdown 中的单独包到 R6 方法

Link to R6 method from separate package in help pages and pkgdown

发自:https://community.rstudio.com/t/link-to-r6-method-from-separate-package-in-help-pages-and-pkgdown/134702

我目前正在编写一个 R 程序包,并想 link 到单独程序包中的 R6 方法的帮助页面。我想 link 到的页面在这里:https://mc-stan.org/cmdstanr/reference/model-method-sample.html, and there is an .Rd file for the method as well (https://github.com/stan-dev/cmdstanr/blob/master/man/model-method-sample.Rd)。最后,我还可以直接使用 ?cmdstanr::`model-method-sample`.

从 R 访问帮助页面

但是,当我尝试使用正常的 link 将 link 添加到我自己的帮助页面时,我得到了 here[cmdstanr::`model-method-sample`] 中描述的另一个包语法此错误:

Warning: Link to unknown topic: cmdstanr::`model-method-sample`

我觉得肯定有某种方法可以 link 到这个帮助页面,因为它确实存在并且有一个 .Rd 页面,但我还没有找到解决方案。还有其他人 运行 遇到这个问题或知道解决方案吗?

我认为您(或 Roxygen)对 link 使用了错误的语法。根据 Writing R Extensions,Rd 语法应该是:

\link[cmdstanr]{model-method-sample}

我不确定如何从 Roxygen 生成它,但如果我将它放在 Roxygen 评论中,它似乎可以工作 as-is。

如果你想要 link 不同的文本,语法是

\link[cmdstanr:model-method-sample]{link text}