准备
install.packages(c("devtools", "roxygen2", "testthat", "knitr"))
创建包目录
打开RStudio
library("devtools")
create_package("D:/yyds")
运行之后会自动打开另外一个界面，当前目录即为包目录。
修改Description
修改描述包的一些信息。
创建函数
可以手动创建函数：
library("devtools")
use_r("hd")
自动在R目录创建了名为hd.R的文件，这这里面就可以写函数的所有信息
前面写函数的注释信息，然后接着写函数的内容
这里给出一个例子：
#' Enhanced version of 'head'.
#' Default only print 5x5 field for two-dimensional data
#' or first 5 element for one-dimension data.
#' And print dimension of data in first line.
#' It also support specified range.
#' Don't worry about going out of range, it can fix it!
#'
#'
#' @title hd
#' @param obj data object.
#' @param x Number to print of horizontal direction, defaut 5.
#' @param y Number to print of vertical direction, defaut 5.
#' @author Jiahao Wang
#' @examples
#' hd(LETTERS, 10)
#' hd(LETTERS, 24:100)
#' df = get(data(package = "ggplot2", "diamonds"))
#' rownames(df) = paste0("row_", 1:nrow(df))
#' colnames(df) = paste0("col_", 1:ncol(df))
#' hd(df)
#' hd(df, 3, 5)
#' hd(df, 3:5, 7:9)
#' hd(df, -10:-nrow(df), -3:-5)
#' hd(df, (nrow(df) - 2):10^6, (ncol(df) - 2):10^6)
#' @return A part of input data.
#' @export
hd <- function(obj, x = 5, y = NULL){
check_len <- function(idx, max){
if(length(idx) > 1){
if(max(idx) > max){
idx_res = idx[idx <= max]
}else{
idx_res = idx
}
}else{
if(idx > max){
idx_res = 1:max
}else{
idx_res = 1:idx
}
}
return(idx_res)
}
if(is.null(y))
y = x
dims = is.null(dim(obj))
if(!dims){
cat("dim:", nrow(obj), "×", ncol(obj), "\n")
idx_x = check_len(x, nrow(obj))
idx_y = check_len(y, ncol(obj))
res = data.frame(obj[idx_x, idx_y])
if(!is.null(rownames(obj)))
rownames(res) = rownames(obj)[idx_x]
if(!is.null(colnames(obj)))
colnames(res) = colnames(obj)[idx_y]
} else{
cat("dim:", length(obj), "\n")
idx_x = check_len(x, length(obj))
res = obj[idx_x]
if(!is.null(names(obj)))
names(res) = names(obj)[idx_x]
}
return(res)
}
我编写了一个方便查看一二维数据的函数，可以这里注释信息包括以下部分：
-
Description
这部分具体描述函数的功能，没有特定的标签，在最开始书写，可换行
-
title
一般即为函数名
-
param param_name param_description
这部分为所有参数的描述，一个参数需要单独一个标签，可换行
-
author
作者
-
examples
举栗
-
return
返回值的描述
-
export
将此函数导出至环境中，使用户可以使用，不写该标签的话用户不能使用，但是可以在该R脚本内调用（private？？)
还有很多其他标签，可以输入#' @后按tab键查看。
检查、生成Rmd文档
check()
devtools::document()
这一步骤先检查上一步书写语法是否有误以及是否有遗漏等其他错，之后将注释信息和函数转换为Rmd文档。
检测结果只要没错误就问题不大，不过也需要看一下具体过程。
导出/安装
setwd("../")
system("Rcmd build yyds")
install_local("yyds_0.0.0.9000.tar.gz")
使用
library(yyds)
packageDescription("yyds")
?hd
hd(iris)
image-20220126155031820
最后
- 这里只是非常简单的一个示例，实际开发中还可能会涉及包的依赖、环境的依赖、面向对象编程、语言的交互、内置数据、Vignettes编写、版本控制等等内容，以后需要的话再来补充吧
- 具有相似功能的函数可以写在同一R文件内，如果函数没有注释信息则用户不能使用，但在文件内部可以调用
- 对于一些比较基础的包，可以设置启动R时自动加载
网友评论