时间戳

首页 > 解决方案 > 记录 R 包给出警告 @example 不存在

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

问题描述

我正在尝试在 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)' 不存在

你们有谁知道这个错误可能是什么。这是函数本身（其他函数也返回相同的警告）

# 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))

}

标签： rr-package

解决方案

您想使用@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)" 在目录中。

推荐阅读