如何解决Roxygen2 无法处理以下划线开头的文件?
我有一组小函数,我想将它们添加到 R 包中。我在一个文件中列出了所有函数,在每个函数之前都有用于构建帮助文件的 Roxygen2 指示(下面的示例)。这一切都很好。但是,我注意到当我将该文件重命名为以下划线开头时(以便它首先出现在我的文件列表中),我收到以下错误消息:
Updating mypackage documentation
Loading mypackage
Writing NAMESPACE
Writing NAMESPACE
Warning message:
In setup_ns_exports(path,export_all,export_imports) :
Objects listed as exports,but not present in namespace: a,b
这是 R 子文件夹中唯一文件的内容:
#' @name a
#' @title the a() function does etc.
#' @description etc.
#' @param x a dataframe containing etc.;
#' @param v a vector containing etc..
#' @return a dataframe of the etc.
#' @export a
a <- function(x,v) { return("somevalue") }
#' @name b
#' @title the b() function does etc.
#' @description etc.
#' @param x a dataframe containing etc.;
#' @param v a vector containing etc..
#' @return a dataframe of the etc.
#' @export b
b <- function(x,v) { return("some other value") }
当我删除下划线并重新运行 devtools::document()
两次时,错误消息消失了。我放回下划线,错误又回来了。当没有 Roxygen2 标签时,没有错误并且功能运行良好。
这是正常行为吗?有没有办法解决这个错误,还是我应该放弃使用下划线的想法?
解决方法
这不是(只是)roxygen2
,这是 R 语言。
来自 Writing R Extensions,小节 1.1.5 Package subdirectories:
R
子目录仅包含 R 代码文件。要安装的代码文件必须以 ASCII(小写或大写)字母或数字开头,并具有以下扩展名之一:.R
、.S
、.q
、.r
、或.s
。
同样,
man
子目录应包含(仅)R 文档 (Rd) 格式的包中对象的文档文件。文档文件名必须以 ASCII(小写或大写)字母或数字开头,并具有扩展名 .Rd
(默认值)或 .rd
。
这通常不是使用 roxygen2
的问题:虽然它确实根据函数名称命名 .Rd
文件,但 R 不允许以下划线开头的函数名称(通常)。来自 R Language Definition 小节 10.3.2 Identifiers:
标识符由一系列字母、数字、句点(‘.’)和下划线组成。它们不得以数字或下划线开头,也不得以句点后跟数字开头。
虽然可以使用以下划线开头的标识符定义函数,但它需要将函数名称包装在反引号中,以便定义和使用时(因为它不是“有效标识符”)。
>版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。