在我的R包中，我为我的类实现了[（索引）操作符：
#' Some title
#' @export
setMethod("[", list(x="MyClass"), function(x, i, j, ...) {
# Some code
})字符串
现在，在包文档中，我想链接到这个方法的手动条目。我尝试正常的方法，使用methodName,className-method：
#' [[,MyClass-method]型
但这只是在.Rd文件中的\link命令外部放置了一个左括号：
[\link{,MyClass-method}型
如果我试图以某种方式引用它，我会遇到其他问题：我已经尝试了反引号，单引号和双引号，最后将括号[[加倍，但这些似乎都没有产生在最终PDF中实际工作的链接。
如何使用Roxy交叉引用[方法？
1条答案
按热度按时间5fjcxozz1#
从
roxygen2中的“rd-formatting”小插曲（您可以使用vignette("rd-formatting", package = "roxygen2")看到）：指向包含特殊字符的操作符或对象的链接目前无法工作。因此，要链接到
magrittr包中的%>%操作符，而不是[magrittr::%>%]，您需要使用Rd表示法：\code{\link[magrittr]{\%>\%}}。这适用于记录
[以及其他运算符，包括“assign”运算符/使用“assign”运算符<-的函数。例如，字符串
所有工作。如果你想链接到另一个包的操作员，用
otherPackage替换myPackage。