У меня есть два метода для универсального S3 (, определенные в другом пакете), которые тесно связаны между собой, и поэтому я хотел задокументировать их в одном Rd
. ] файл. Однако, когда я документирую их аргументы отдельно, я получаю предупреждение из R CMD check
о «Дублирующихся записях \argument в объекте документации»
##' Create a ggplot of a Kaplan-Meier Survival curve(s)
##'
##' @param data A \code{survfit} object returned from \code{\link{survfit}}
##' @param \dots Unused
##' @return A ggplot2 object
autoplot.survfit <- function(data,...) {
NULL
}
##' @rdname autoplot.survfit
##' @param data A \code{\link{survfit.fortify}} object returned from \code{\link{fortify.survfit}}
autoplot.survfit.fortify <- function(data,...) {
NULL
}
. Первый аргумент должен быть data
, потому что это то, что определяет дженерик. Однако документация для него отличается для разных методов, хотя бы потому, что он должен относиться к другому классу. У меня могло бы быть два отдельных файла документации для этого, но они тесно связаны, поэтому я хотел бы сохранить их вместе. Я мог бы перечислить все возможные классы data
в первом вызове и не иметь ничего в последующих, но это означает, что я документирую вторую функцию с первой, а не храню все это вместе, как это делается в Roxygen.
Можно ли заставить roxygen создать допустимый (не дублирующий аргумент)из нескольких методов? Если нет, то как лучше всего справиться с этим сценарием?