完整的工作文档一般有四个基本的步骤：
- 添加roxygen注视到.R文件
- 运行devtools::document()将roxygen注释转成.Rd文件
- 利用?来预览文件
- 修改注释，重复上面这些步骤
这个过程从源文件中添加roxygen注释开始：roxygen注释以#'开始，以区别一般的注释.
我写一个我自己的例子:
#' Train A Model
#' @param train train data
#' @param test test data
#' @param model which model you chioce
Mlr_Modle <- function(Train,Test,model)
保存文件，然后
devtools::document()
?
image.png
这个就是你函数的相关文档
另外一个文档的工作流程
- 给
R文件添加roxygen注释 - 在编译窗格点击点击reload，这将重新编译整个包，包括更新所有文档，将其安装在的常规库，然后重启R并重新加载包。
- ？预览文档
- 修改文档，重复上面的工作
包文档
用一个页面来描述包，可以通过package？包名来访问他。
需要新建一个.R文档，然后手动提供标签@docType package和@name 包名
类似于这样：
#' fristpak Is a package that I usually use in my
#' work, which involves the balance of data,
#' woe transformation of data, modeling, etc.
#' @docType package
#' @name fristpk
#'
NULL
类，泛型和方法的文档
S3 泛型是普通函数，可以选择函数的文档来提供文档。
S4 在setClass前添加一个roxygen块来为S4提供文档
其他详细细节参考：http://r-pkgs.had.co.nz/
