r - 在包中包含 ggplot2 函数

Question

我试图在一个包中包含以下 ggplot2 辅助函数 [它将标签包装在 grid_facet(.~variable, labeller = "plot.label.wrap")] 中:

#' Label wrapper for ggplot
#'
#' Include in the facet_grid option of ggplot.
#' @param variable
#' @param value
#' @return wrapper
#' @export

plot.label.wrap <- function(variable, value) {

  lapply(strwrap(as.character(value), width=15, simplify=FALSE),
         paste, collapse="\n")
}

我的描述文件包括:导入:ggplot2。使用该函数的脚本包括:library(ggplot2)。

该包构建、重新加载并在 ?plot.label.wrap 上提供文档。可以找到:

> getAnywhere(plot.label.wrap)
A single object matching ‘plot.label.wrap’ was found
It was found in the following places
  registered S3 method for plot from namespace mypackage
  namespace:mypackage
with value

function(variable, value) {

  lapply(strwrap(as.character(value), width=15, simplify=FALSE),
         paste, collapse="\n")
}
<environment: namespace:mypackage>

然而:

> plot.label.wrap
Error: object 'plot.label.wrap' not found

所以我的问题是，为什么这个函数可以在 mypackage 的命名空间中找到，而不是在命令行本身中找到？

Answer 1

评论中的解决方案是更具体地说明如下导出

#' Label wrapper for ggplot
#'
#' Include in the facet_grid option of ggplot.
#' @param variable
#' @param value
#' @return wrapper
#' @export plot.label.wrap

plot.label.wrap <- function(variable, value) {

  lapply(strwrap(as.character(value), width=15, simplify=FALSE),
         paste, collapse="\n")
}

roxygen 试图在 @usage 之类的事情上变得聪明, @details , 和 @exports使事情更简单，但有时，就像在这个例子中一样，它并不总是有效。
plot是 S3 通用方法，可以定义为 plot.someclass这将为某些对象创建绘图方法 x与 class “someclass”，可以简单地通过 plot(x) 调用.

roxygen 认为 someclass您的包裹是“label.wrap”并导出 plot.label.wrap作为 S3 方法而不是普通函数，期望您将其用作 plot(x)哪里class(x)是“label.wrap”而不是试图使用 plot.label.wrap直接尝试(并发现它不起作用)。

或者，就像提到的@shadow 一样，您可以通过不在函数名称中使用句点来避免这种混淆，例如 plot_label_wrap , plot_label.wrap , plot_labelwrap等。您不必这样做，但在极少数情况下，使用句点会导致意外行为。