Я написал класс S4 в пакете R. Я использую roxygen2
для документации:
#' A timeframe class represents a start date, end date and frequency
#'
#' @slot start_date First date in the timespan
#' @slot end_date Last date in the timespan
#' @slot frequency 'D', 'W' or 'M' for daily, weekly or monthly
#' @export
#' @exportClass timeframe
timeframe <- setClass( "timeframe", slots = c(start_date = "Date", end_date = "Date", frequency = "character"),
prototype = list(
start_date = lubridate::as_date(lubridate::today() - 367),
end_date = lubridate::as_date(lubridate::today() - 1),
frequency = "D"
),
validity = function(object) {
# ...some validation stuff...
}
)
Позже я пишу функцию перегрузки, чтобы сделать пользовательский интерфейс более приятным:
#' @param start_date First date in the timespan
#' @param end_date Last date in the timespan
#' @param frequency 'D', 'W' or 'M' for daily, weekly or monthly
#' @export
timeframe <- function(start_date, end_date, frequency = "D") {
# ...some validation steps, such as setting default dates if they're missing...
return_object = new("timeframe", start_date = start_date, end_date = end_date, frequency = frequency)
return(return_object)
}
Я думаю, мне нужно задокументировать обе вещи, чтобы автозаполнение intellisense работало независимо от того, каким образом пользователь создает объект timeframe
. Проблема в том, что документация дублирует некоторые вещи: Что я делаю не так? Как это исправить?