如何查找R包中设置的options？含识别与文档规范两类技术疑问

1. 如何识别已加载包所引用的options？ #

• 优先查阅包的官方文档：包括包的vignette、README，或者专门的配置说明章节，部分包会单独列出所有专属options
• 搜索包的源代码：使用grep("options\\(", system.file(package = "目标包名"), recursive = TRUE)命令，查找包源码中调用options()的位置，定位设置或读取专属options的代码
• 筛选当前已设置的选项：执行options()获取所有全局选项，再通过包名关键词筛选，比如针对RBesT包可以用grep("RBesT", names(options()), value = TRUE)
• 查看关联对象的帮助文档：部分包会在特定函数、数据集的帮助页中提及相关options，比如RBesT的模拟参数options就出现在?crohn文档里

2. R包中的“options”应如何编写文档？是否无法将包专属options追加至基础?options的Rd文件中？ #

文档编写的最佳实践 #

• 在包的vignette中新增专门章节（如「包配置选项」），集中说明每个option的用途、默认值、合法取值范围
• 在包的主帮助页面（如?目标包名）中添加「Options」小节，快速指引用户查看详细配置
• 若option与特定函数强绑定，在该函数的帮助文档中明确标注对应的配置选项
• 创建独立的帮助页面（如?目标包名-options），统一管理所有专属options的说明

关于追加至基础?options的问题 #

• 无法也不建议修改基础包（base）的Rd文件：修改基础包文档会破坏R的原生环境，且R版本更新或基础包升级后，修改内容会被覆盖丢失
• 正确的做法是在自身包的文档体系内完整说明专属options，避免依赖基础?options的文档

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