r - 如何在另一个包中使用 ggplot_add
问题描述
我正在尝试构建一个严重依赖 ggplot2 的数据可视化包,但对于我面临的一些日常问题有一些自定义快捷方式。
我可以使用ggplot_add
函数+
从脚本扩展自定义类的功能,但是当我将这些脚本添加到包中时,它ggplot_add
不再起作用。
下面我粘贴了一个 minrep,复制第一个需要创建一个包(我正在使用 RStudio),我称之为 SOExa。该项目包含以下文件:
.Rbuildignore
^.*\.Rproj$
^\.Rproj\.user$
描述
Package: SOExa
Type: Package
Title: An minrep for a problem I'm having
Version: 0.1.0
Author: Col Bates
Maintainer: The package maintainer <yourself@somewhere.net>
Description: I want to use ggplot2's ggplot_add from inside another package, i.e. this one.
It seems that when I do I get an error.
License: GPLv2
Encoding: UTF-8
Imports:
dplyr,
magrittr,
tidyr,
glue,
ggplot2
LazyData: true
RoxygenNote: 7.1.1
我的项目文件SOExa.Rproj
一个名为 R 的文件夹,其中包含 minrep 的使用示例:
R/design_by.R
#' the function to add a 'designed by' to the plot
#' as a designed_by class
#'@export
designed_by<-function(x){
return(new_designed_by(x))
}
#' generic constructor.
#' @export
new_designed_by<-function(x){
x <- list('designed_by' = x)
class(x) <- 'designed_by'
return(x)
}
#' generic print for designed_by
#' @export
print.designed_by <- function(x){
print(paste('Designed by:', format(x)))
}
#' defines the addition of an designed_by object for
#' @export
ggplot_add.designed_by <- function(object, plot, objectname){
plot$designed_by <- object$designed_by
plot
}
ggplot_add <- function(x){
UseMethod("ggplot_add")
}
我运行以下代码来构建命名空间文件
devtools::document()
创建一个新文件:
命名空间
# Generated by roxygen2: do not edit by hand
S3method(ggplot_add,designed_by)
S3method(print,designed_by)
export(designed_by)
export(new_designed_by)
在此之后,我安装并加载库:
devtools::install()
library(SOExa)
然后创建一个空图:
p <- ggplot2::ggplot()
以下将导致错误:
p <- p + designed_by('Col Bates')
我得到的错误是:
# Error: Can't add `designed_by("Col Bates")` to a ggplot object.
# Run `rlang::last_error()` to see where the error occurred.
所以按照这些步骤:
rlang::last_error()
哪个返回
# <error/rlang_error>
# Can't add `designed_by("Col Bates")` to a ggplot object.
# Backtrace:
# 1. ggplot2:::`+.gg`(p, designed_by("Col Bates"))
# 2. ggplot2:::add_ggplot(e1, e2, e2name)
# 4. ggplot2:::ggplot_add.default(object, p, objectname)
# Run `rlang::last_trace()` to see the full context.
跑步
rlang::last_trace()
我明白了
<error/rlang_error>
Can't add `designed_by("Col Bates")` to a ggplot object.
Backtrace:
x
1. \-ggplot2:::`+.gg`(p, designed_by("Col Bates"))
2. \-ggplot2:::add_ggplot(e1, e2, e2name)
3. +-ggplot2::ggplot_add(object, p, objectname)
4. \-ggplot2:::ggplot_add.default(object, p, objectname)
由此我可以推断出调用的 ggplot2::ggplot_add()UseMethod('ggplot_add')
决定应用该函数ggplot_add.default
,并且没有识别我的类designed_by
。
顺便说一句,使用该print()
函数确实可以从库中使用。
print(designed_by('Col Bates'))
但是,如果我要获取脚本,而不是像下面这样使用包:
source('./R/designed_by.R')
p <- p + designed_by('Col Bates')
它确实按我期望的方式工作。
深入研究,我可以看到ggplot_add
类上泛型的来源designed_by
是我的包。
sloop::s3_methods_generic("ggplot_add")
## A tibble: 1 x 4
# generic class visible source
# <chr> <chr> <lgl> <chr>
# 1 ggplot_add designed_by TRUE SOExa
而对于 ggplot 类,它是“注册的 S3method”
> sloop::s3_methods_generic("ggplot_add")
## A tibble: 14 x 4
# generic class visible source
# <chr> <chr> <lgl> <chr>
# 1 ggplot_add by FALSE registered S3method
# 2 ggplot_add Coord FALSE registered S3method
# 3 ggplot_add data.frame FALSE registered S3method
# 4 ggplot_add default FALSE registered S3method
# 5 ggplot_add Facet FALSE registered S3method
# ...
我查看了ggplot2源代码,但无法真正弄清楚它是如何工作的。我也一直在阅读https://adv-r.hadley.nz/s3.html但没有看到任何关于使用适用于另一个库中的类的 S3methods 的信息。
弄清楚是否可以将调用打包到我的自定义包中,或者我是否总是需要依赖采购,那就太好了。
谢谢。
解决方案
这是一个让我很头疼的常见问题。您需要确保您的包可以访问ggplot2
的ggplot_add
通用功能。您可以通过以下两种方式之一进行此操作。
您需要在包中的某处包含以下行:
#' @import ggplot2
这将使所有 ggplot2 函数可用,或者如果您只使用该函数,请执行以下操作:
#' @importFrom ggplot2 ggplot_add
这有点不直观,但仅仅因为DESCRIPTION
文件说它导入了一个包,并不意味着您的包的命名空间将能够看到该包的功能。您始终可以通过查看NAMESPACE
文件来检查这一点。NAMESPACE
当您包含上面的建议时,您应该在文件底部看到以下行之一
import(ggplot2)
importFrom(ggplot2,ggplot_add)
推荐阅读
- express - 在 minikube 中运行的快速服务中使用 Redis
- ios - 增强现实应用程序因致命错误而崩溃:在隐式展开可选值时意外发现 nil
- python - 如何从其他 pandas DataFrames 创建 MultiIndex DataFrame
- java - JDK 17 中针对接口的反射调用
- vue.js - 我们可以在嵌套的 vuedraggable 中禁用对特定元素的拖放吗
- html - 您可以将包含 html 的变量从模块文件发送到模板吗
- mysql - 如何根据单个属性填写另一个表中的数据
- html - 父母:相对孩子:绝对与孩子:相对有什么区别?
- c# - 通过支持 User-Agent、Cookie 和 Accept 标头的 SOCKS4/5 代理发出 HTTP/S 请求?
- javascript - 除非我刷新,否则 React 侧边栏菜单项不会更新活动状态