如何在RStudio开发的自定义R包中添加示例文件目录以支持@examples正常运行
R包集成示例文件目录操作步骤
- 首先在R包项目根目录下创建
inst/extdata层级目录,所有需要用到的示例文件都存放在该目录下,你也可以根据文件分类在extdata下新增多级子目录存储。R包构建安装时,inst文件夹下的所有内容会被原样复制到包的安装路径,不会被当做源码或元数据处理。 - 调整@examples部分的路径写法,所有示例文件的路径都通过
system.file()函数生成,不要使用本地硬编码路径。假设你的包名为myfsPkg,主函数名为read_myfs,示例文件存放在inst/extdata/sample_dir下,样例写法参考:
library(myfsPkg) # 自动定位示例文件目录路径 sample_path <- system.file("extdata", "sample_dir", package = "myfsPkg") # 调用主函数读取 result_df <- read_myfs(sample_path)
- 检查项目根目录下的
.Rbuildignore文件,确保没有将inst/extdata路径添加到忽略列表中,否则打包时示例文件会被剔除,导致样例运行失败。 - 开发阶段可通过
devtools::load_all()加载本地开发包后,运行样例代码验证路径是否生效、文件是否能被正常读取,确认无误后再执行包的构建检查。
注意:如果你的示例文件包含压缩包、二进制类特殊格式,可按需在
DESCRIPTION文件的Suggests字段添加对应读取依赖包,避免样例运行时出现依赖缺失报错。
内容的提问来源于stack exchange,提问作者Marek Fiołka
相关产品推荐
相关产品推荐

