r - 从帮助页面和 pkgdown 中的单独包链接到 R6 方法

标签 r r-package roxygen2 r6

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

我目前正在编写一个 R 包,并希望链接到单独包中的 R6 方法的帮助页面。我想要链接到的页面在这里:https://mc-stan.org/cmdstanr/reference/model-method-sample.html ,并且该方法还有一个 .Rd 文件 ( https://github.com/stan-dev/cmdstanr/blob/master/man/model-method-sample.Rd )。最后,我还可以使用 ?cmdstanr::`model-method-sample` 直接从 R 访问帮助页面。

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

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

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

最佳答案

我认为您(或 Roxygen)使用了错误的链接语法。根据编写 R 扩展,Rd 语法应该是:

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

我不确定如何从 Roxygen 生成它,但如果我将它放在 Roxygen 注释中,它似乎会按原样工作。

如果您想要具有不同文本的链接,语法为

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

关于r - 从帮助页面和 pkgdown 中的单独包链接到 R6 方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/71928086/

相关文章:

r - 在 R 中正确绘制大型邻接矩阵

r - 用上面行中的值填写数据框

r - 堆叠库的多个调用(…,include.only=…)不起作用

r - 安装R包的问题

r - 构建自己的包但加载后命名空间为空

r - 如何自定义向 ggplot 分面函数添加垂直线?

R:如何通过仅比较每个字符串中的前 3 个制表符分隔项来对两个字符串向量使用 setdiff?不使用 qdap

r - 如何指向R包中的目录?

r - 如何在描述中自动添加/更新依赖/导入/建议版本?

roxygen2:即使在使用 @export 后,函数也不会导出到 NAMESPACE