R包开发流程

2021-07-12 09:47:46 浏览数 (1)

R包开发

创建R包基本流程：

开发工具：devtools 运行调试 usethis 创建修改

基本流程：

  • create_package 创建一个R包
  • use_r()写函数,插入roxygen注释和tag，使用document()生成文档
  • load_all()载入包
  • use_***_license 添加license
  • install安装包
  • use_testthat() 和use_test()生成测试文件；test()进行测试
  • check对整个包进行检查
  • use_readme_rmd()和build_readme()生成readme文件

开发工具：

代码语言：txt复制
install.packages("devtools")
library(devtools)
library(usethis)

初始化package项目: create_package()

代码语言：txt复制
usethis::create_package("~/toypackages")

创建函数：usethis::use_r() -> R/*.R -> 添加R函数脚本(合并因子)

代码语言：txt复制
usethis::use_r("fbind")
代码语言：txt复制
fbind <- function(a, b) {
  factor(c(as.character(a), as.character(b)))
}

交互载入验证:devtools::load_all() 快捷键：Ctrl Shift L -> man

代码语言：txt复制
devtools::load_all()
a <- factor(c("character", "hits", "your", "eyeballs"))
b <- factor(c("but", "integer", "where it", "counts"))
fbind(a,b)

自动检查包：devtools::check() 快捷键：Ctrl Shift E

代码语言：txt复制
devtools::check()

添加license: 修改DESCRIPTION文件 -> metadata (作者/包名称 /简介等)

代码语言：txt复制
					`use_mit_license()`   -> `MIT` license
代码语言：txt复制
usethis::use_mit_license("xiongfeng chen")

添加函数帮助文档：

man/*.Rd <- roxygen2包生成

fbind.R -> Code>Insert roxygen skeleton

代码语言：txt复制
#' @examples
#' fbind(iris$Species[c(1, 51, 101)], PlantGrowth$group[c(1, 11, 21)])
fbind <- function(a, b) {
  factor(c(as.character(a), as.character(b)))
}

生成man/fbind.Rd文件：document() 快捷键：Ctrl Shift D

代码语言：txt复制
document()
代码语言：txt复制
?fbind

生成包：install（） -> toypackages_0.0.0.9000.tar.gz

代码语言：txt复制
install()

测试包:

代码语言：txt复制
library(toypackage)
a <- factor(c("character", "hits", "your", "eyeballs"))
b <- factor(c("but", "integer", "where it", "counts"))
fbind(a, b)

规范测试:

use_testthat() -> DESCRIPTION文件加入suggests:testthat:

代码语言：txt复制
								 -> 创建tests/testthat`文件夹，并生成`testthat.R`文件
代码语言：txt复制
library(devtools)
use_testthat()

创建测试文件：use_test() -> 生成tests/testthat/test-fbind.R文件

代码语言：txt复制
use_test("fbind")

修改测试内容: expect_*fun()

代码语言：txt复制
test_that("fbind() binds factor (or character)", {
  x <- c("a", "b")
  x_fact <- factor(x)
  y <- c("c", "d")
  z <- factor(c("a", "b", "c", "d"))

  expect_identical(fbind(x, y), z)
  expect_identical(fbind(x_fact, y), z)
})

进行测试：test() 快捷键:Ctrl Shift T

代码语言：txt复制
test()

调用其他包函数: use_package()

代码语言：txt复制
						-> `DESCRIPTION`文件添加 `Imports::forcats`
代码语言：txt复制
use_package("forcats")

R包readme说明文件：use_readme_rmd() build_readme()

创建数据：usthis::use_data() - > 'data/x.rda' / 'data/mtcars.rda'

代码语言：txt复制
x <- sample(1000)
usethis::use_data(x, mtcars，`internal = TRUE`）

保留原始数据：usethis::use_data_raw() -> data-raw和DATASET.R

代码语言：txt复制
usethis::use_data_raw()

数据文档说明：R/data.R

代码语言：txt复制
#' Prices of 50,000 round cut diamonds.
#'
#' A dataset containing the prices and other attributes of almost 54,000
#' diamonds.
#'
#' @format A data frame with 53940 rows and 10 variables:
#' describe{
#'   item{price}{price, in US dollars}
#'   item{carat}{weight of the diamond, in carats}
#'   ...
#' }
#' @source url{http://www.diamondse.info/}
"diamonds"

包文档说明： <-package?dplyr调出

创建包：usethis::create_package(path)

代码语言：txt复制
			工作路径最好是源码包的top-level

参考：

R packages 2nd edition

cheatsheet

image-20200916155008545image-20200916155008545
腾讯云测试服务 r语言 tcp/ip

0 人点赞