R包开发总结

R包开发流程


   1.准备工作
  1.1 一些准备好的R函数，数据
  1.2 在Rstudio中创建一个R Package项目
  1.3 下载并安装devtools包，此包简化了R包开发的许多流程
  1.4 下载并安装roxygen2包，此包用来为R包添加文档




   2.开发流程
  2.1 添加函数
  2.1.1 R文件
在R包中，所有R文件都要添加到R文件夹中。注意不能在R文件夹中放入子文件夹，否则roxygen2的document文件无法写入
  2.1.2 书写函数文档
在加载了roxygen2包之后，可以在函数上方用 #' 符号为函数添加文档。
函数文档分几个部分。
1，标题，只能占用一行，不长于80个字符。
2，详细介绍，空一行之后，可以占用多行.第二段开始会放入文档的details中。每行同样不能超过80个字符。
3。examples。在文档中添加@examples或@example后添加R语句，即为文档的例子。
4，返回值，在文档中添加@return之后添加返回值解释。
5.引用其他文档段，添加@describein或@rdname域，并加上文档名，即可直接引用其他的文档段。这两个域的区别是，
添加@describein之后仍然可以添加其他的文档内容。而使用@rdname的话，在此域后面，只能用域来添加文档，
不能添加description文档。所有没有域名的文档都必须添加到@rdname的上方。