构建 R 包：未记录的 S4 类（已记录在案！）

Question

我正在构建一个带有“参考类”（RC）类的 R 包。现在我正在准备 CRAN 提交。

我的主要导出类如下所示：

#' Oceans 2.0 API Client Library
#'
#' Provides convenient & easy access to Ocean Networks Canada's data.
#' For detailed information and usage examples, visit our
#' \href{https://wiki.oceannetworks.ca/display/O2A/R+Client+Library}{official Documentation}.
#'
#' @name Onc
#' @field token character. User token
#' @field showInfo logical. Print verbose debug comments
#' @field timeout numeric. Number of seconds before a request to the API is canceled
#' @field baseUrl character. Base URL for API requests
#' @field outPath character. Output path for downloaded files
#'
#' @export Onc
#' @exportClass Onc
Onc <- setRefClass("Onc",
    fields = list(
        token    = "character",
        showInfo = "logical",
        timeout  = "numeric",
        baseUrl  = "character",
        outPath  = "character"
    ),

    methods = list(
    (...)

当我构建和检查我的包时，我收到以下警告：

未记录的 S4 类：'Onc' 包中的所有用户级对象（包括 S4 类和方法）都应具有文档条目。请参阅“编写 R 扩展”手册中的“编写 R 文档文件”一章。

它甚至不是一个 S4 类，而是一个参考类，我相信它有据可查。我如何通过这个检查？

Answer 1

1个月后，我回答我自己的问题：

这是文档格式（作为 R 中的大多数新事物，这种格式的文档记录很差）。以下工作完美，请注意与原始文档字符串的差异：

#' Onc Class
#'
#' Provides convenient & easy access to Ocean Networks Canada's data.
#' For detailed information and usage examples, visit our
#' \href{https://wiki.oceannetworks.ca/display/O2A/R+Client+Library}{official Documentation}.
#'
#' @field token character. User token
#' @field showInfo logical. Print verbose debug comments
#' @field timeout numeric. Number of seconds before a request to the API is canceled
#' @field baseUrl character. Base URL for API requests
#' @field outPath character. Output path for downloaded files
#'
#' @exportClass Onc
Onc <- setRefClass("Onc",
    fields = list(