记录 R 包给出警告 @example 不存在

Question

我正在尝试在 R 中构建一个新包，但每次我尝试使用 devtools document() 函数记录该包时，它都会给我一个找不到示例的错误。具体错误是这样的：

警告：[C:\Users\User\Desktop\RProject\ExcelFunctionsR\R\AND.R:9] @example 'C:\Users\User\Desktop\RProject\ExcelFunctionsR/AND(iris$Species == "setosa", iris$Petal.Length == 1.4)' 不存在

你们中有人知道这个错误可能是什么吗？这是函数本身（其他函数return同样的警告也是如此）

# COUNT Function from Excel
#' Basic COUNT function from excel
#'
#' It acts similiarly to Excel's COUNT function.
#'
#' @param value Count amount of the values in the range.
#' @import base
#' @import plyr
#' @export
#' @example
#' COUNT(iris$Species)

COUNT <-
function(value){

  sum(count(value)[,2]) - sum(is.na(value))

}

Answer 1

您想使用@examples 而不是@example

当您想使用包含示例的外部文件时，使用@example 指令。如果您直接在 roxygen 文档中包含示例，请使用 @examples.

请注意，这就是它抱怨文件不存在的原因。在您的 'AND.R' 文件中，您想要使用的示例可能是 "AND(iris$Species == "setosa", iris$Petal.Length == 1.4)" 因此它试图查找名为 "AND(iris$Species == " 的文件setosa", iris$Petal.Length == 1.4)" 在目录中.

记录 R 包给出警告 @example 不存在

Documeting R package gives warning @example doesnt exist

r

r-package