问题复现

Y 叔有一个神包,能够在 ggplot 图层里随心所欲的添加各种 emoji,然而很多人在使用的时候却不能「随心所欲」,经常一行函数输进去一张白板输出来。最近在我的星球里也有人提到这个问题,作为一个无趣的人我虽然之前没有实际使用过这个有趣的包,但是今天要被迫营业了。

在反馈中可以看到 Windows 中的基本错误信息有两类:一是提示 warning,虽然能出图但是图和想象中的样子不一样;二是提示 warning,然后直接输出一个空白图层。其中 warning 的内容是: In grid.Call.graphics(C_text, as.graphicsAnnot(x$label), x$x, x$y, : Windows 字体数据库里没有这样的字体系列。

以下是两个错误示例

library(tidyverse)
library(emojifont)
load.emojifont()
ggplot() +
    geom_emoji("rose", color='steelblue') +
    theme_void()

虽然这个图画出来了,但是这图和正确的图竟然不一样。下图为正确的图。

另一个错误示例是:

ggplot() + geom_fontawesome("fa-github", color='black') + theme_void()

输出 warning 信息后直接扔出一个白板。

Warning message:
In grid.Call.graphics(C_text, as.graphicsAnnot(x$label), x$x, x$y,  :
  Windows 字体数据库里没有这样的字体系列

因为输出白板这里就不放截图了。

问题定位

这个问题有两个地方需要注意,一般我们说遇到warning不用管,但是这里不得不管因为图没展示出来;二是没有报error说明本身代码或者调用的函数没有问题,也就是**图没有出来不是画图(代码)的问题而是打印(设备)的锅。**这里的设备是指图形设备,所以不妨换个图形设备打印一下看看效果,比如用最基本的png()进行测试。

png(file = "test_emoji.png")
ggplot() +
    geom_emoji("rose", color='steelblue') +
    theme_void()
dev.off()

需要注意的是使用png()打开一个图形设备后,在运行画图代码时就没有了上文的警告内容。然后看保存的结果也是正常的。当然,如果使用ggsave去保存也没有任何问题。

至此问题就基本定位应该是 RStudio graphics device 和这个包并不兼容。接下来就是查一查有没有好的解决方案。

解决方案

作为一个如此成熟和受欢迎的 R 包,遇到问题以后和我们通常的 debug 思路是不太一样的。

一般情况下我们会在搜索引擎中输入主要的报错信息,然后加上错误工具的名字等进行检索。但是现在不妨直接去对应的 GitHub 查看已有的 issue。当我打开 emojifont 的 issue 列表时,我感觉这个问题已经解决了。

基本上所有关闭的 issue 都集中在字体上,其中涉及到了 Windows 和 macOS,再看看那些没有关闭的问题,基本也都是和字体相关。(相比此时 Y 叔已经心力交瘁)

简单翻了两个问题,就是我们文章开头提到的内容。既然用户已经有了这么多困扰,把写好文档作为 R 包开发准则的 Y 叔想必会在文档里写清楚这个问题。二话不说,立刻打开文档去瞅瞅。打开以后就会发现在目录上清晰的写着一个** limitation**。本能促使我点开它,然后看到了下面这样一段话:

也就是说,因为 emojifont 依赖于 showtext ,而 showtext 本身和 RStudio GD 存在兼容性问题,所以在 Rstudio 中会出现各种问题,这也是为什么直接用png()保存则正常。因此给出的解决建议是即便在使用 Rstudio,也还是用系统本身的 GD 去打印,在 Windows 中就用 windows() 在 Mac 中就用 quartz(),然后万事大吉功成身退。

如下图所示

问题复盘

关于 emojifont 的实现方式,其实在文档中一开始就写了是用 showtext 去 render 字体。它本身只是打印出 emoji 对应的 unicode。因为我是先收到了 bug 才去使用这个包,所以本身就没有按照正常的顺序去学习。

学习使用一个工具时,第一步就应该是先去看官方文档和使用说明。其实 Y 叔这个包的说明文档已经十分精简了,但还是有很多人可能从来没有打开过。另外,在使用成熟的工具遇到问题时,也要学会查看已有的 issue ,你的问题可能早在两三年前就已经被开发者回答和解释过。

One More Thing

问题解决之后还有一个小的发现。

在 Rstudio 上使用 Rmd 写文章,如果常规操作导出 HTML 那 emojifont 还是会出现无法正确打印的问题。解决方案其实就在 showtext 的说明文档中 。需要注意如下两点。

  1. 在文档的 header 添加 fig_retina:1
  2. 在使用到 emojifont(showtext) 的代码块中,添加fig.showtext = TRUE

Rmd 代码如下:

导出 HTML 效果如下:


本文作者:思考问题的熊

版权声明:本博客所有文章除特别声明外,均采用 知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议 (CC BY-NC-ND 4.0) 进行许可。

扫码即刻沟通