在CMD检查期间,Roxygen示例中的“找不到功能”

时间:2017-06-23 13:09:37

标签: r devtools roxygen2

我正在对RStudio中的软件包运行CMD检查,其中一部分分析了内联Roxygen文档中的@examples

我收到了这个错误:

checking examples ... ERROR
Running examples in ‘packagename-Ex.R’ failed
The error most likely occurred in:

> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: checkDate
> ### Title: Ensure that a date string is a valid date
> ### Aliases: checkDate
> 
> ### ** Examples
> 
> checkDate("2017-05-06")
Error: could not find function "checkDate"

在我的.R文件中,文档定义为:

#' Ensure that a date string is a valid date
#'
#' @param dateString A string (eg. "2017-12-04").
#' @return TRUE or FALSE (and a warning if FALSE).
#' @examples
#' checkDate("2017-05-06")
#' checkDate("2017-05-40")

我正在使用devtools 1.13.2和roxygen2 6.0.1,我认为这两者在发布时都是最新的。

我有其他使用相同devtools / roxygen2组合的软件包,但从未见过它在@examples范围内找不到函数名称。

其他人似乎遇到过与this question更新相似的内容,但我看不出有人说如何修复它。

1 个答案:

答案 0 :(得分:2)

我的猜测是你需要{Rover评论中的#' @export函数,否则该函数不会被导出到包的命名空间中,也无法找到它。