如何在自定义R包中导入patchwork包的|运算符？

问题背景 #

开发R自定义包时，需要用patchwork的|运算符拼接ggplot图形，但该运算符是patchwork的内部S3方法（|.ggplot），未对外导出，直接用@importFrom patchwork "%|%"或@importFrom patchwork "|"导入时，devtools::document()会报错：Warning message: object ‘|’ is not exported by 'namespace:patchwork'。

可行解决方案 #

方案1：全量导入patchwork（最简单直接）

这是最省心的实现方式，无需额外配置：

• 在包的DESCRIPTION文件中添加：Imports: patchwork
• 在需要使用|运算符的函数所在R文件的roxygen注释中添加：

  #' @import patchwork
  

  包加载后即可直接使用|拼接ggplot图形，devtools::document()不会再报错。

方案2：手动注册S3方法（轻量导入）

如果不想全量导入patchwork，可以手动注册其内部的|.ggplot方法，步骤如下：

1. 在包的R目录下创建zzz.R文件（专门用于包加载时的初始化操作）
2. 在zzz.R中添加以下代码：

   .onLoad <- function(libname, pkgname) {
     if (requireNamespace("patchwork", quietly = TRUE)) {
       # 注册patchwork针对ggplot类的|运算符方法
       registerS3method("|", "ggplot", patchwork:::`|.ggplot`)
     }
   }
   

3. 在DESCRIPTION中添加：Imports: patchwork
4. 在使用|的函数所在R文件的roxygen注释中，仅导入实际需要的patchwork函数（如果有的话），比如：

   #' @importFrom patchwork ggplotGrob
   

注意事项 #

• 手动注册S3方法时，requireNamespace("patchwork", quietly = TRUE)能确保包加载时不会因patchwork未安装而抛出错误
• 测试包功能时，需确认包加载后|运算符能正常拼接ggplot图形
• 若包中仅使用|运算符，方案2能减少不必要的依赖导入，更轻量化

示例代码调整（包内使用版本） #

移除原示例中的library(patchwork)，替换为上述导入方式即可：

library(ggplot2)

df <- data.frame(vals = c(10, 5, 18),
                 name = c("A", "B", "C"))
bp <- df |>
  ggplot() +
  geom_bar(aes(x = name, y = vals), stat = "identity") +
  coord_flip() +
  xlab("") +
  theme_bw() +
  theme(axis.title.x=element_blank(),
        axis.text.x=element_blank(),
        axis.ticks.x=element_blank()) 

# 创建用于附加的小图
p1 <- ggplot(df, aes(x = vals, y = vals)) + geom_point() + theme_bw() +
  theme(axis.title.x = element_blank(),
        axis.text.x  = element_blank(),
        axis.ticks.x = element_blank(),
        axis.title.y = element_blank(),
        axis.text.y  = element_blank(),
        axis.ticks.y = element_blank()) 

p3 <- p2 <- p1
myList <- list(p1, p2, p3)

# 构建轴附加图
width <- .9
p_axis <- ggplot(df) +
  geom_blank(aes(y = name)) +
  purrr::map2(myList, seq_along(myList), ~ annotation_custom(ggplotGrob(.x), ymin = .y - width / 2, ymax = .y + width / 2)) +
  theme_void() 

# 直接使用|拼接（包内已通过上述方式导入该运算符）
p_axis | bp

内容的提问来源于stack exchange，提问作者Electrino