У меня есть два метода для общего S3 (определенного в другом пакете), которые тесно связаны, и поэтому я хотел документировать их в том же файле Rd
. Однако, когда я документирую свои аргументы отдельно, я получаю предупреждение от R CMD check
о "Дублированных\аргументах в объекте документации"
##' 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 для создания юридического (не дублирующего аргумента) из нескольких методов? Если нет, то каков наилучший способ справиться с этим сценарием?