使用roxygen2构建R包时的文档错误及gzfile连接问题

我之前也碰到过一模一样的问题，这其实是R包文档同步出了小状况，给你整理了直接的解决办法和背后的原因：

快速解决办法 #

当你遇到Error in gzfile(file, "rb") : cannot open the connection报错，或者?function_name调不出帮助界面时，直接在控制台运行这条命令：

devtools::document()

运行完成后，再试一次输入函数名或调取帮助，问题应该就消失了。

为什么会出现这个问题？ #

这个报错本质是R包构建后，文档相关的辅助文件没生成完全或者同步出错：

• 当你输入函数名触发参数提示弹窗时，R会去读取函数的元数据缓存文件，如果这个文件缺失或损坏，就会触发gzfile连接错误；
• 用?调取帮助时，R需要读取对应的.Rd帮助文档，如果这些文档没被正确生成，自然打不开帮助界面。

而devtools::document()的核心作用，就是基于你包内的roxygen2注释（就是你写在函数上方的#'开头的注释），重新生成所有必要的文档文件，同步函数元数据，让R能顺利找到并读取这些文件，自然就恢复正常了。

额外小建议 #

• 每次修改函数的参数、注释，或者新增函数后，记得跑一遍devtools::document()，保持代码和文档同步；
• 如果问题反复出现，可以先删掉包目录下的man文件夹和NAMESPACE文件，再重新运行devtools::document()，彻底重建整个文档系统，能解决大部分顽固的文档同步问题。

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