目的

走一遍R包开发过程,并发布到Github上使用。

步骤

1. 创建R包框架

Rsutdio ——> File——> New Project——> New Directory ——> R Package



创建完成后,在R包文件夹下有如下文件(夹):

  • man: 存放*.Rd文件
  • R: 存放R脚本
  • DESCRIPTION: R包描述信息
  • NAMESPACE: 命令空间
  • rmytools.Rproj: R工程文件

2. 自定义R包

上面是Rstudio为开发者创建的一个框架,接下来是对自己开发的R包进行编写和注解。

①编写功能函数

点击Rstudio右下角Files中的R目录新建R函数(自带了一个hello.R)。要实现什么样的功能就编写相应函数,函数功能的组织和构建也是开发者重要的技能之一。这里作为示例,随便写了个画饼图的函数(因为现有画饼图的函数都不友好)。

my_pie <- function(data,ncol){
plotdat <- as.data.frame(table(data[,ncol])) %>% dplyr::arrange(-Freq)
plotdat$Label <- paste(plotdat$Var1, paste0("(",round(((plotdat$Freq/sum(plotdat$Freq))*100),2),"%)")) p <- ggplot(plotdat, aes (x="", y = Freq, fill = factor(Var1))) +
geom_col(position = 'stack', width = 1) +
geom_text_repel(aes(label = Label, x = 1.3),size=5,
position = position_stack(vjust = 0.5)) +
theme_classic() +
theme(plot.title = element_text(hjust=0.5),
axis.line = element_blank(),
axis.text = element_blank(),
axis.ticks = element_blank()) +
labs(fill = "Category",x = NULL,y = NULL) +
coord_polar("y")
}

与一般的函数编写不同的是,我们需要对这个函数编写文档,这就是为什么我们在用R包中函数时可用?来查看函数帮助。

编写完成后。。。

第一步,给函数添加注释,这里是对函数整体进行roxygen注释,方便文档生成,而非普通代码注释。光标放在函数名上,使用Ctrl+Shift+Alt+R快捷键即可生成一个基本模板,我们根据需要进行相应修改即可。

#' Using a dataframe specific column to plot a pie figure
#'
#' @param data a dataframe or tibble
#' @param ncol specific column, factor
#'
#' @return a figure as ggplot2 object
#' @export
#'
#' @examples
#' my_pie(mtcars,ncol=2)
#' my_pie(diamonds,ncol=3)
#' my_pie(diamonds,ncol=3)+guides(fill="none")
#'
my_pie <- function(data,ncol){
plotdat <- as.data.frame(table(data[,ncol])) %>% dplyr::arrange(-Freq)
plotdat$Label <- paste(plotdat$Var1, paste0("(",round(((plotdat$Freq/sum(plotdat$Freq))*100),2),"%)")) p <- ggplot(plotdat, aes (x="", y = Freq, fill = factor(Var1))) +
geom_col(position = 'stack', width = 1) +
geom_text_repel(aes(label = Label, x = 1.3),size=5,
position = position_stack(vjust = 0.5)) +
theme_classic() +
theme(plot.title = element_text(hjust=0.5),
axis.line = element_blank(),
axis.text = element_blank(),
axis.ticks = element_blank()) +
labs(fill = "Category",x = NULL,y = NULL) +
coord_polar("y")
}

第二步,运行devtools::document(),会在man文件夹下生成该函数的Rd文件:

如果修改了函数的注释,需要重新执行第二步。

每个函数都是这样添加注释和文档,比如再添加一个ID转换的函数:

②修改DESCRIPTION

点击右下角Files中的DESCRIPTION对模块进行修改。



添加一些主要的信息即可:

  • Package: 包名
  • Description: 描述信息
  • Depends: 依赖R版本(要注意空格,否则后续会报错)
  • Suggest:建议包,非必需
  • Imports:依赖包(这里编写的函数依赖了图中5个R包)
  • License:协议

③安装R包

Rstudio ——> Build,可构建源码包或者二进制包。



点击后会进行编译以及更新文档。

使用?my_pie等编写的函数,已经可以查看文档了,说明编译成功,已经可以使用R包了。

3. 上传Github

如果只是自己使用,可以放在本地。本着R语言开源精神,要想分享给其他人使用,需要有地方托管。权威认可的地方如CRAN、Bioconductor等,但如果专业度不够高或者处于开发阶段,还是托管在Github上吧。

从本地仓库上传到Github远程仓库,与一般代码上传无异。

首先,进入本地R包目录。

git init
git add .
git commit -m 'my first r package'

然后,登录Github新建Repository(建议用SSH地址,尽量不要用HTTPS地址)。

第三,本地仓库关联GitHub,上传代码。

git remote add origin git@github.com:***/test.git
git pull origin master #先pull下
git push -u origin master

有个小插曲,我在pull的过程中,遇到了如下错误:



原因是SSH keys没有设置或者过期了,SSH keys 可以在没有密码的情况下信任当前工作的计算机。解决办法是生成并设置SSH keys。具体可参考这篇教程:解决github Permission denied (publickey)问题。

上传成功。

4. 安装使用

devtools工具为我们提供了Github的R包安装方式:

devtools::install_github("**/my_rpackage/rmytools")
library(rmytools)

用内置数据集试下:

my_pie(mtcars,2)
my_pie(diamonds,ncol=3)
my_pie(diamonds,ncol=3)+guides(fill="none") #ggplot2对象,自由编辑

用R包来管理组织自己平时经常用的代码是一种非常高效的方式,后续想添加任何功能或修改原有脚本,只需git push,重新装一下R包即可。是时候整理整理之前混乱的代码了(俗称屎山)。

Ref:

Kai Gu:如何快速写一个R包

如何上传本地代码到github

R包开发过程记录的更多相关文章

  1. 机器学习数据集,主数据集不能通过,人脸数据集介绍,从r包中获取数据集,中国河流数据集

    机器学习数据集,主数据集不能通过,人脸数据集介绍,从r包中获取数据集,中国河流数据集   选自Microsoft www.tz365.Cn 作者:Lee Scott 机器之心编译 参与:李亚洲.吴攀. ...

  2. 极简 R 包建立方法--转载

    https://cosx.org/2013/11/building-r-packages-easily/ 最近想试一下捣腾一个 R 包出来,故参考了一些教程.现在看到的最好的就是谢益辉大大之前写过的开 ...

  3. 如何创建R包并将其发布在 CRAN / GitHub 上--转载

    转载--https://www.analyticsvidhya.com/blog/2017/03/create-packages-r-cran-github/ 什么是 R 包?我开始创建 R 包的原因 ...

  4. 如何制作自己的R包?

    摘自 方匡南 等编著<R数据分析-方法与案例详解>.电子工业出版社 R包简介 R包提供了一个加载所需代码.数据和文件的集合.R软件自身就包含大约30种不同功能的包,这些基本包提供了R软件的 ...

  5. 如何制作自己的R包

    如何制作自己的R包? 摘自 方匡南 等编著<R数据分析-方法与案例详解>.电子工业出版社 R包简介 R包提供了一个加载所需代码.数据和文件的集合.R软件自身就包含大约30种不同功能的包,这 ...

  6. R语言无网络安装R包,彻底解决依赖问题!

    R version: 3.5.3, 3.6.3 更新日期: 2020-9-10 大家测试后多提建议哈, 有问题我会持续更新的 在工作中,我们使用的服务器通常是不能联外网的,这在安装R包的时候产生了巨大 ...

  7. R包MetaboAnalystR安装指南(Linux环境非root)

    前言 这是代谢组学数据分析的一个R包,包括用于代谢组学数据分析.可视化和功能注释等众多功能.最近有同事在集群中搭建蛋白和代谢流程,安装这个包出现了问题,于是我折腾了一上午. 这个包的介绍在:https ...

  8. 普通用户安装 R 包

    转自 http://bnuzhutao.cn/archives/901 一般 R 语言的书籍上,介绍安装 R 包的方法都是这样的: install.packages("packagename ...

  9. R包介绍

    R语言的使用,很大程度上是借助各种各样的R包的辅助,从某种程度上讲,R包就是针对于R的插件,不同的插件满足不同的需求,截至2013年3月6日,CRAN已经收录了各类包4338个. 一. R语言包的安装 ...

随机推荐

  1. 关于tkinter

    tkinter介绍 tkinter是python自带的GUI库,是对图形库TK的封装tkinter是一个跨平台的GUI库,开发的程序可以在win,linux或者mac下运行 组件概念 一个窗口中任意内 ...

  2. Java:Set接口小记

    Java:Set接口小记 对 Java 中的 Set接口 与 其实现类,做一个微不足道的小小小小记 概述 public interface Set<E> extends Collectio ...

  3. 解决git clone慢问题

    解决git clone慢 关于Git克隆或是上传代码龟速的问题真是让人很恼火,这里对于网上的两种解决方案进行摘录. 利用码云克隆github项目 亲测有效 进入码云,新建一个仓库: 在创建的最后选择导 ...

  4. BUAA软件工程个人博客作业

    软件工程个人博客作业 项目 内容 这个作业属于哪个课程 2020春季计算机学院软件工程(罗杰 任健) 这个作业的要求在哪里 个人博客作业 我在这个课程的目标 团队完成好的软件,并对自己作出规划 这个作 ...

  5. BUAA 2020 软件工程 热身作业

    BUAA 2020 软件工程 热身作业 Author: 17373051 郭骏 项目 内容 这个作业属于哪个课程 2020春季计算机学院软件工程(罗杰 任健) 这个作业的要求在哪里 第一次作业-热身! ...

  6. 大厂面试题分享:如何让(a===1&&a===2&&a===3)的值为true?

    当我第一次看到这一题目的时候,我是比较震惊的,分析了下很不合我们编程的常理,并认为不大可能,变量a要在同一情况下要同时等于1,2和3这三个值,这是天方夜谭吧,不亚于哥德巴赫1+1=1的猜想吧,不过一切 ...

  7. 8M的摄像头,30fps摄像时,60hz的LCD刷新频率,请问camera每秒向BB传输多少数据,如何计算

    8M的摄像头,30fps摄像时,60hz的LCD刷新频率,请问camera每秒向BB传输多少数据,如何计算 xiang2012 Post at 2012/8/7 10:37:33 8M的摄像头,30f ...

  8. CSP-S 2021 退役记

    写的比较草率,但的确是真实感受. 10.23 回寝室前敲了一个 dinic 板子,觉得不会考... 10.24 8:00 起床,还好今天宿管不在,可以起的晚一点. 吃了早饭来机房颓废. 10:00 似 ...

  9. 你们不要再吵了! Java只有值传递..

    写在前边 上次聊到Java8新特性 lambda时,有小伙伴在评论区提及到了lambda对于局部变量的引用,补充着博客的时候,知识点一发散就有了这篇对于值传递还是引用传递的思考.关于这个问题为何会有如 ...

  10. SpringBoot 全局异常拦截捕获处理

    一.全局异常处理 //Result定义全局数据返回对象 package com.xiaobing.demo001.domain; public class Result { private Integ ...