在哪里放置生成包数据的R文件
Where to put R files that generate package data
我目前正在开发一个 R 包,希望它尽可能干净,所以我尝试解决 devtools::check()
.
显示的所有警告和注意事项
其中一个注释与我用于生成示例数据以随包一起使用的一些代码相关:
checking top-level files ... NOTE
Non-standard file/directory found at top level:
'generate_sample_data.R'
它是一个 R 脚本,目前位于包根目录中,并不打算随包一起分发(因为包含它似乎并没有多大用处)
所以这是我的问题:
我应该把这样的文件放在哪里,或者我如何告诉 R 把它放在那里?
.Rbuildignore
是正确的方法吗?
目前 devtools::build()
将 R 脚本放在最终包中,所以我不应该忽略注释。
如 http://r-pkgs.had.co.nz/data.html 中所建议的那样,将 ./data-raw/
用于 scripts/functions 是有意义的,因为 creating/updating 数据是必需的,但不是您在包本身中需要的东西。将 ./data-raw/
添加到 ./.Rbuildignore
后,程序包生成应该忽略该目录中的任何内容。 (而且,正如您评论的那样,有一个辅助函数 devtools::use_data_raw()
。)
我目前正在开发一个 R 包,希望它尽可能干净,所以我尝试解决 devtools::check()
.
其中一个注释与我用于生成示例数据以随包一起使用的一些代码相关:
checking top-level files ... NOTE
Non-standard file/directory found at top level:
'generate_sample_data.R'
它是一个 R 脚本,目前位于包根目录中,并不打算随包一起分发(因为包含它似乎并没有多大用处)
所以这是我的问题:
我应该把这样的文件放在哪里,或者我如何告诉 R 把它放在那里?
.Rbuildignore
是正确的方法吗?
目前 devtools::build()
将 R 脚本放在最终包中,所以我不应该忽略注释。
如 http://r-pkgs.had.co.nz/data.html 中所建议的那样,将 ./data-raw/
用于 scripts/functions 是有意义的,因为 creating/updating 数据是必需的,但不是您在包本身中需要的东西。将 ./data-raw/
添加到 ./.Rbuildignore
后,程序包生成应该忽略该目录中的任何内容。 (而且,正如您评论的那样,有一个辅助函数 devtools::use_data_raw()
。)