美文网首页
生信技巧每日分享day15-编写R包

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

作者: 江湾青年 | 来源:发表于2023-03-07 15:40 被阅读0次

创建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

相关文章

  • R语言视频笔记

    【生信技能树】生信人应该这样学R语言 01.介绍R语言及Rstudio 1.了解并安装R,Rstudio以及R包 ...

  • Day6-冯致远

    学R包: 1. R包是啥?是多个函数的集合。Biocductor上有各种生信分析的R包。 2. Biocducto...

  • 可能会用到的R语言包~3

    gtable 生信菜鸟团 公众号分享的文章 R包:gtable包用于处理ggplot2图像 ggrgl 画三维图 ...

  • 学习小组day6--学习r包--ling

    R包是多个函数的集合。学生信,可以用r语言丰富的图表和biocductor的各种生信分析r包。这次以dplyr为例...

  • 生信零基础 Day6 by Sure栗子

    继续R学习-R包的简单应用 以下资源均来自“生信星球公众号” R包及其小抄 R包是别人写好的封装好了的命令包,有各...

  • 学习小组Day6笔记--R包入门(李夕)

    R包说明书(cheatsheet),俗称小抄,除了今天跟着生信星球了解R包,还可以通过小抄了解。 R包入门之tid...

  • 学习小组DAY6笔记--Peng

    思维导图 R包的新手教程1.6.1 生信学习【R包的新手教程】DAY6.png 正式笔记 0. R包的获取 Rst...

  • 三、差异分析

    三大R包差异分析 可视化 三大R包差异基因对比 #########生信技能树课程笔记

  • 生信R语言学习资源瞄一眼

    1、CRAN有大量的R包,根据用途查找 2、生物、生信相关的R包在Bioconductor 3、大神的写的R包和代...

  • 【R】 装包提示 package ‘xxx’ is not av

    本人因学习生信入门R语言,按照生信技能树JIMMY给的R包安装代码运行,有4个包未能顺利安装:GSEABa...

网友评论

      本文标题:生信技巧每日分享day15-编写R包

      本文链接:https://www.haomeiwen.com/subject/ehclldtx.html