我正在编写一个R包,目前正通过R CMD check
devtools::check()
我在两个我的函数中有以下roxygen2
引用S4类(两个函数都返回此类的对象):
#' @return An object of class \code{\link{mod_imputeMulti}}
#' @aliases mod_imputeMulti
#' @seealso \code{\link{multinomial_em}}, \code{\link{multinomial_impute}}
然而,我得到以下警告:
带有重复别名'mod_imputeMulti'的Rd文件:
'multinomial_data_aug.Rd''multinomial_em.Rd'
如果我不使用第二行 - @aliases
标记,我会收到此警告,尽管我做有一个链接:
检查Rd交叉引用...警告
缺少文档对象'multinomial_data_aug.Rd'中的链接或链接: 'mod_imputeMulti'文档对象'multinomial_em.Rd'中缺少链接或链接: 'mod_imputeMulti'
请参阅“编写R扩展”手册中的“交叉引用”部分。
注意:将\code{\link{mod_imputeMulti}}
添加到@seealso
不会改变此(第二个)警告
正确的语法是什么?
我查看过很多参考资料,但无法在任何地方找到解决方案:
我希望这对某人来说很简单 - 提前感谢您的帮助!
S4类文件如下:
#' Class "mod_imputeMulti"
#'
#' @name mod_imputeMulti-class
#' @description A multivariate multinomial model imputed by EM or Data Augmentation is
#' represented as a \code{\linkS4class{mod_imputeMulti}} object. A complete
#' dataset and model is represented as an \code{\linkS4class{imputeMulti}} object.
#' Slots for \code{mod_imputeMulti} objects include: (1) the modeling method;
#' (2) the call to the estimation function; (3) the number of iterations in estimation;
#' (4) the final log-likelihood; (5) the conjugate prior if any; (6) the MLE estimate of
#' the sufficient statistics and parameters.
#' @docType class
#' @section Objects from the class: Objects are created by calls to
#' \code{\link{multinomial_impute}}, \code{\link{multinomial_em}}, or
#' \code{\link{multinomial_data_aug}}.
#' @seealso \code{\link{multinomial_impute}}, \code{\link{multinomial_em}},
#' \code{\link{multinomial_data_aug}}
#' @export
setClass("mod_imputeMulti",
representation= list(
method= "character",
mle_call= "call",
mle_iter= "numeric",
mle_log_lik= "numeric",
mle_cp= "character",
mle_x_y= "data.frame"),
validity= function(object) {
if (!object@method %in% c("EM", "DA", "NULL")) {
return("Currently only EM and DA methods are defined.")
} else if (object@mle_iter < 0) {
return("A negative iteration was given.")
}
return(TRUE)
}
)
答案 0 :(得分:1)
是的,这是一个相对简单的修复方法。
正如您在OP底部的S4类文档中所看到的,请注意该名称为mod_imputeMulti-class
,而不是mod_imputeMulti
。
我需要添加“ - class”。 <{1}}标记是不必要的。
@aliases
另外,感谢@thomas指出使用#' @return An object of class \code{\link{mod_imputeMulti-class}}
将@slot
标记正确翻译为roxygen2
个文件。