R语言开发软件包(打包)流程
整理相应的文件
R文件夹
该文件夹中存放所有要打包的函数R脚本,在每个脚本的上面可以添加一些信息。例如
#’ This function ***. (Description)
#’
#’ @param
#’ @export
#’ @examples (examples )
#’ fbm()
#’ plot(fbm())
#’ d <- fbm(hurst=0.2, n=1000)
需要注意的是 #’ @export 一定要有,这个可以在你后面check的时候可以有这个函数,要不然会报function not found问题。其他行无所谓。
data文件夹(可有)
该文件夹中存放所有要打包的数据文件,rda格式即可。save(data, file=“data.rda”)
man文件夹
该文件夹中存放所有打包文件(脚本和数据)的介绍,Rd文件即可。否则,在R语言help中则不会出现例子。例子中如果有较为耗时的代码,可用\dontrun{}来not run。
DESCRIPTION文件
关于整个R包的简单介绍,主要包括开发人、需要载入的包等。
vignettes文件夹(可有)
关于整个R包的详细介绍,包括每个函数的介绍例子等,方便使用者学习。文件类型时.Rmd格式。
README.md(可有)
关于整个R包的简单介绍,操作流程。
打包
设置对应路径,然后
devtools::document() # 生成NAMESPACE文件
devtools::check() # 检查
devtools::build() # 封包