【问题标题】:Roxygen2 cannot process files begining with underscore?Roxygen2 无法处理以下划线开头的文件?
【发布时间】:2021-03-23 12:29:50
【问题描述】:

我有一组小函数,我想将它们添加到 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 标签时,没有错误,功能运行良好。

这是正常行为吗?有没有办法解决这个错误,还是我应该放弃使用下划线的想法?

【问题讨论】:

    标签: r devtools roxygen2


    【解决方案1】:

    这不是(只是)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

    标识符由一系列字母、数字、句点 ('.') 和下划线组成。它们不能以数字或下划线开头,也不能以句点后跟数字。

    虽然可以使用以下划线开头的标识符定义函数,但它需要将函数名称包装在反引号中以便定义和任何时候使用它(因为它不是“有效标识符”)。

    【讨论】:

    • 那为什么当文件中没有Roxygen2 cmets时库会起作用?
    • 我无法正确加载它,所以我不知道为什么它似乎对你有用。
    猜你喜欢
    • 1970-01-01
    • 2016-04-06
    • 2015-02-25
    • 1970-01-01
    • 2014-03-16
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多