R包制作（千字详细图文）

新建R包项目
包命名，创建系统目录
删除man文件和NAMESPACE文件
编辑DESCRIPTION
编写函数/功能
添加函数/功能的帮助文档
添加内置数据（可不添加）
添加单元测试unit test（可不添加）
补全man和NAMESPACE文件
添加vignette文档（可不添加）
检查check()
包的创建与安装

具体步骤

1. 新建R包项目

依次点击：
File -> New Project -> New Directory -> R Package

2. 给R包命名，创建R包项目所在的目录

注意：这里未勾选创建git仓库和使用项目的环境**

3. 点击R包项目所在文件夹，删除man和NAMESPACE两个文件

注意：删除的文件后续由roxygen2包自动生成

4. 编辑描述文档DESCRIPTION

主要是Title、Author、Maintainer、Description和内置数据LazyData（true表示有内置数据，false表示没有内置数据）

5. 编写相关的函数，保存到项目的R文件夹中；

6. 为函数写帮助文档（即输入“?函数名”后出现的帮助文档）

第一种方法：借助快捷指令生成，但是生成的信息太少，不推荐。
首先需要导入两个包：

library(devtools)
library(roxygen2)

然后双击打开函数文件后，光标放在该函数的.R文件上不动，在RStudio中使用Ctrl+Shift+Alt+R的快捷键，会自动帮你在原文件中生成一部分的注释信息，后续仍要补全信息。
第二种方法：直接复制（推荐）包含的内容更多，以下是样例（可直接复制）

#' @title Dynamic knapsack.
#' @description Creating dynamic algorithm to solve knapsack problem.
#' @details Input takes a data.frame x with two variables v and w and returns the maximum knapsack value and which elements (rows in the data.frame).
#' @param x A a data.frame x with two variables v and w.
#' @param W The knapsack size.
#' @return A list with the maximum knapsack value and which elements.
#' @export
#' @import
#' @importFrom
#' @examples

参考：http://personalbioinformatics.blogspot.com/2019/01/r.html
注意：谨慎添加example，因为在后面check的时候，RStudio会直接运行example，如果运行example的时候失败，同样会报错。
函数帮助文档如下图所示：

7. 添加包的内置数据（可不添加）

首先在R文件夹中新建脚本，命名为data.R(命名不固定，要和函数文件名区分)，编写数据生成的方法。
注意：这里生成的数据都是比较小的，比如data.frame
参考14.1节：https://r-pkgs.org/data.html

然后，运行指令：

usethis::use_data(knapsack_objects)

knapsack_objects是数据集的名称（任意命名），它位于前的环境中，产生于前面的数据生成脚本，当然，也可以将任何位于当前环境中的数据集进行添加，只需更改数据集名字即可。
运行该指令后，将自动生成一个data文件夹，并将数据集保存该文件夹中，以.rda结尾的文件。

自动生成的data文件夹和.rda数据集：

8. 添加单元测试（可不添加）

首先运行指令：

usethis::use_testthat()

这个指令将执行以下的操作：
1、Create a tests/testthat directory.创建相关目录；
2、Add testthat to the Suggests field in the DESCRIPTION.在DESCRIPTION文件中补全（添加）单元测试的信息；
3、Create a file tests/testthat.R that runs all your tests when R CMD check runs. (You’ll learn more about that in automated checking.)创建一个testthat.R脚本，这个脚本负责运行单元测试，不需要人为修改；

然后编写测试程序，以.R结尾的脚本，放入tests testthat文件夹中；
单元测试脚本一般要自己写，少数情况能使用别人写好的脚本。
注意：不要人为修改testthat.R脚本，这是一个负责运行/启动单元测试的脚本。

然后，运行单元测试，输入以下指令：

devtools::test()

对照提示，更改所有报错

9. 自动补全man和NAMESPACE文件

自动生成这两个文件，运行：

library(devtools)
devtools::document()

注意：每次更新了.R文件后，都要运行这个代码更新.Rd文件；
man文件包含了函数的帮助文档

注意：man文件中的.Rd文件无法手动修改，为自动生成。如需修改，先删除man和NAMESPACE两个文件，再运行

devtools::document()

10. 添加vignette文档（可不添加）

运行指令：

usethis::use_vignette("my-vignette")

该指令将：

1.在R包项目文件中，创建一个 vignettes/ 目录；
2.向 DESCRIPTION 添加必要的依赖项（即，它向 Suggests 和VignetteBuilder 字段添加字段值 knitr）；
3.起草一个vignette，vignette/my-vignette.Rmd。

之后编辑my-vignette.Rmd
更多编辑可以参考https://r-packages-zh-cn.readthedocs.io/zh_CN/latest/%E7%AC%AC%E4%B9%9D%E7%AB%A0%20Vignette%EF%BC%9A%E9%95%BF%E7%AF%87%E6%96%87%E6%A1%A3.html#vignette

11. 执行检查check()

会同时运行单元测试，下面的例子是没有包含单元测试的截图
运行代码：

check()

全绿则代表检查无误，“warning和notes都问题不大，主要看有没有errors，一般问题都出在函数的bug上，跟着系统的提示修改bug就可以了。”
参考：https://www.jianshu.com/p/46442fd976ed

也可以点击Build check来执行上述操作，结果是一样的。
注意：运行check()的同时，也会运行单元测试，未通过单元测试的错误一样会显示出来。

12. 点击Build Build source package

没有error的话，点击Build - Build source package，R会自动生成这个包，并加载这个包。
参考：https://www.jianshu.com/p/46442fd976ed

之后就可以正常使用这个包了，点击Install and Restart