R包发布在CRAN上

我最近开发的一个R包被CRAN接收了,发布在:https://cran.rstudio.com/web/packages/chromseq/index.html

主要参考的文章:R package: https://r-pkgs.org/index.html

实际上是很简单的一个R包,可以实现分割含不同染色体序列的fasta文件,函数也不多,就5个,代码也不复杂。

写R包的初衷,可能还是自己一个比较大胆的想法吧,希望可以利用现有的工具做点东西出来。当时刚好参考了大神在公众号发布的文章:https://mp.weixin.qq.com/s/loKVJJPxGyRWYOF3pYDOdw

然后自己尝试用R写了一遍,发现没有想象中的那么简单(当然我自己水平有限,还没有能力一下子写高效的c),然后顺便写了几个可以用来处理fasta和list的相对通用的函数,最后整合在一起。

接下来谈谈我写这个包的经验:

先是对R包有个自动审核,一般是可以先用check函数初步检查,没有问题再用check_rhub()检查。注意:check检查没有问题不代表真的没有问题,必须经过check_rhub()检查没有问题才算。不然可能还会被CRAN检查出ERROR,像下面这样:

error_fix.jpg

CRAN对于R包的自动审核尤其严格,一丁点错误都不能有!除了会严格检查你给函数写的example运行实例,还会检查一切你给函数、data写的文档,比如给data写的文档像下面这样:

#' 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"

我建议像我一样的R包开发新手,可以先参考别人在Github上发布的R包的结构,心中有数,再跟着 https://r-pkgs.org/index.html里的步骤走一步看一步,前面的几章内容非常重要,中间的可以选择性看,最后的关于check和release最为重要,因为它决定了你的包的质量和成功发表的可能。

自动审核不通过永远是R包开发里面最痛苦的,我被拒了n多次:

R_hub.jpg

文档都要写详细的引用和description,代码加注释,Git应用和Github管理,仔仔细细检查报错信息,一般代码写错都是error,没写文档就是warning。note相对轻微,可能只是拼写、格式上的问题,不过要发布到CRAN上最好尽可能去除一切note。

另外,自动审核是会对你的包在不同平台上进行测试的,如果在windows上没问题,在linux上、macOS上可能会有问题,比如文件路径里的分隔符,一定要避免直接出现在代码里。

虽然我这个R包非常简单,但至少实现了我从0到1的跨越,敢于尝试总是好的,希望大家都能根据自己的需求,开发出自己的R包,并能成功被CRAN接收。

接下来我考虑shiny的应用以及bionconductor上发布包的要求,继续做新的东西。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342