生信技巧每日分享day15-编写R包

创建R包基本流程

1. 建立R包开发环境

  • 进入Rstudio界面,依次点击File → New project → New Directory → R package,填写好R包名字,选择好开发包的工作目录(其它暂时都不用考虑);最后点击Creat Project即可。

  • 完成后会自动生成以下文件:

    (1)R 文件夹:用于存放R函数脚本的文件夹;里面有一个示例文件hello.R
    (2)man 文件夹:用于存放对应上述R函数的说明文档Rd文件的文件夹;里面有一个示例文件hello.Rd。
    (3)DESCRIPTION:关于R包的说明文档。
    (4)NAMESPACE:声明R包导出以供外部使用的函数以及R包从其他包导入的外部函数。

    其中,只有R函数脚本DESCRIPTION需要我们细心准备外,其它可通过一些办法自动写入、更新。

2. 编写函数

  • 在R文件夹内创建后缀名为.R的函数脚本,编写自定义的函数

  • 把鼠标放置在函数名上,按Ctrl+Alt+Shift+R组合快捷键为函数添加说明文档模板。

  • 最后使用一下代码来生成帮助文档(man文件夹里的Rd文件)

devtools::document()

3. 编写DESCRIPTION文件

  • 手动修改Version(版本号)、Title(包的名字),Authors@R(作者名)、Description(包的简要描述)

  • 使用下述函数,自动编写License部分。如果没有依赖到别的具有不同版权的第三方包的话,一般选择最为广泛使用的 MIT 即可

usethis::use_mit_license()
  • 补充依赖包的信息。包括Depends、Imports、Suggests。

    1. Depends是最强的依赖,即在library的同时也library所依赖的包,在使用被引函数的时候不用加::,但可能会引起函数名冲突,慎用。
    2. Imports:如果只需要使用包中的某个函数,而不是整个包,那么引用类型就是Imports。在函数脚本中,必须按照package::function,如dplyr::filter()的形式。
    3. Suggests:如果没有引用和依赖关系,仅仅是在例子中使用了该包,那么我们仅仅是建议安装这个包,这个时候的关系是“Suggests(建议)”。

    例如,在函数中用到了dplyr的filter()函数,则要使用以下代码将dplyr设为依赖:

usethis::use_package(package, type = "Imports", min_version = NULL)
  • 单独使用Imports、Depends和Suggests引用的都是CRAN上的包,如果想引用Bioconductor上的包,需要在前面加上biocViews:
image.png
  • R包本地安装测试
devtools::install_local('path_to_Rpackage',force = T)

参考:

https://www.jianshu.com/p/c0216f42edc5

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

推荐阅读更多精彩内容