刘小泽写于2020.4.19
题目依然是花花帮忙起的
今天来介绍一个简单又实用的需求，就是如何自动化给每个包添加对应的说明和版本信息
前言
我们首先来假设一个情境，而且一定会遇到：
我自己有一个脚本，想发给别人用，但别人收到后却产生某个包的报错。于是第一步，他会问：你用的R包都是哪个版本啊？我怎么重复不出来？
这时一般我们会用sessionInfo()，得到下面的全部配置
但当我们安装的R包数量有点多时，别人可能要仔细从中寻找对应的包的版本
那么问题来了：能不能一开始加载包的时候，就直接标注包的版本呢？
一个善于观察的人写了一个有趣的包
这个人叫：Luis Verde Arregoitia (https://github.com/luisDVA/annotater)
他在帮助同事进行R debug时发现，同事的脚步中调用了大量的R包，而且错误主要是由于包的依赖关系没有搞好（可能某个依赖包的版本太旧或者太新），另外有很多R包已经忘记是做什么用的了，需要现场一个一个查。
最后，他利用utils::packageDescription()对每个包都查看了一下title和version，最后整理出来，标注好了每个包的作用
# package load ------------------------------------------------------------
library(readr) # Read Rectangular Text Data
library(dplyr) # A Grammar of Data Manipulation
library(sensiPhy) # Sensitivity Analysis for Comparative Methods
library(tibble) # Simple Data Frames
library(weatherData) # Get Weather Data from the Web
他嫌一个一个操作太麻烦，于是他写了个包，对每个R包批量进行utils::packageDescription 查看，并且一键式操作
我们来看看这个包
首先是安装
# install.packages("remotes")
remotes::install_github("luisdva/annotater")
然后重启rstudio，会发现插件（Addins）这里多了这个annotater包
最后一键式操作，点击Annotate package calls in active file
就会看到：
来一个动图：
添加包的说明信息
当然，除了能看每个包的作用（也就是它们的标题），版本可能是更为关心的
再来一个动图：
添加版本信息
但这里需要说明，这个插件只能在library()后面没有注释的情况下使用；
当添加了标题信息后，就不能继续在后面添加标题信息除非把之前的标题信息换行，保证library()没有注释，就可以继续添加新的版本信息【就像下面这样】
最后再回顾一下两个常用的功能：
欢迎关注我们的公众号～_～
我们是两个农转生信的小硕，打造生信星球，想让它成为一个不拽术语、通俗易懂的生信知识平台。需要帮助或提出意见请后台留言或发送邮件到jieandze1314@gmail.com
Welcome to our bioinfoplanet!
网友评论