为什么 devtools 会警告我 @slot 需要名称和描述

Question

我在我的自定义 R 包中设置了以下 class：

#' A stock.returns class is an xts of stock(s) returns, a timeframe and the currency used.
#'
#' @slot xts_returns An xts of stock returns (potentially multiple stocks)
#' @slot timeframe
#' @slot currency Any three letter currency, or "Local"
#' @include timeframe.R
#' @export
stock.returns <- setClass(
    Class = "stock.returns",
    slots = c(xts_returns = "xts", timeframe = "timeframe", currency = "character"),
    prototype = prototype(xts_returns = xts::xts(, order.by = c(lubridate::today())), timeframe = timeframe(), currency = "Local")
)

#' A stock.returns class is an xts of stock(s) returns, a timeframe and the currency used.
#'
#' @param timeframe
#' @param benchmark_code The code for the index of stocks you want the returns for.
#' @param portfolio_code The code for the portfolio of stocks you want the returns for.
#' @param sec_id_list An explicit list of sec_id's you want the returns for.
#' @param currency Any three letter currency, or "Local".  The default is "AUD".
#' @export
stock.returns <- function(
    timeframe, benchmark_code, portfolio_code, sec_id_list, currency = "AUD") { 
        # ... code goes here ...
}

当我运行 devtools::document 自动生成我的 .Rd 文件时，为什么我会收到以下警告？

Warning:
 @slot [stock.returns.R#16]: requires name and description
Warning:
 @param [stock.returns.R#28]: requires name and description

Answer 1

记录的函数参数需要名称和描述。

在您的代码中，@slot timeframe 和 @param timeframe 只有名称部分，它们也需要描述（就像所有其他参数一样）

这不会 affect/stop 构建或安装包，但要在 CRAN 上获取包，您需要完成所有必需的参数和描述。

为什么 devtools 会警告我 @slot 需要名称和描述

Why does devtools give me a warning that @slot requires name and description

r

devtools

roxygen2