roxygen2 error "Error: Don't know how to describe s3method in data."

Question

当我尝试 devtools::document() 我的 R 包时，我得到了结果：

Updating janitor documentation
Loading janitor
Writing NAMESPACE
Error: Don't know how to describe s3method in data.

我已将原因缩小到这些函数 headers:

#' @export
tabyl <- function(...) UseMethod("tabyl")

#' @inheritParams tabyl
#' @describeIn Create a frequency table from a vector, returned as a data.frame, showing percentages and with or without including \code{NA} values.  A fully-featured alternative to \code{table()}.
#' @export
tabyl.default <- function(vec, sort = FALSE, show_na = TRUE, ...) {
  ...
}

#' @inheritParams tabyl.default
#' @param .data a data.frame.
#' @param ... arguments passed to tabyl.default.
#' @describeIn tabyl Create a frequency table from a variable in a data.frame, returned as a data.frame, showing percentages and with or without including \code{NA} values.  A fully-featured alternative to \code{table()}.
#' @export
tabyl.data.frame <- function(.data, ...){
...
}

Answer 1

通用函数的名称必须在 describeIn 和您的描述之间。你错过了它。在上面的示例中，行：

#' @describeIn Create a frequency

应该是：

#' @describeIn tabyl Create a frequency