R语言：创建bioconductor的package

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/sinat_38918949/article/details/82151479

创建bioconductor的package

Bioconductor是生物信息在R语言中常用的软件包，我是做计算生物学中方法学的，所以打算把自己设计的方法做成一个package。

写package的教程，有以下两个文档：
简易版：
Bioconductor官方简介
完全版：
R官方简介

BioC的package本质上是一个R package，BioC的官方简介是R官方简介的简易版本。

按照Bioconductor的介绍

• 在R studio中创建package。自己写的script应该放在“R”文件夹下面。
• 修改DESCRIPTION文件，添加描述，用快捷键ctrl+shift+B来build。

• 修改NAMESPACE。
  在NAMESPACE里面定义两个东西：

  export(‘myFun’,’hello’,’pname’)
  import(‘GenomeInfoDb’)

第一行是展示给user的函数，第二行是在自己的包里面需要调用的别的包的名字。

• documenting manual pages
  写manual要用’.Rd’格式写，命名就是‘MyPkg-package.Rd’。记得要给你写的每个函数都写一个manual，在‘man’文件夹下面。
• 写vignettes
  目的是展示这些函数如何work together。vignettes要用’.Rmd’来写。

A good vignette should first explain what the package is for, and then it should provide a common workflow for how that package could be used to accomplish that. In doing so, it puts all the functions and classes into context so that new users can find their way.

注记：
在下在搞NAMESPACE时候，import老是不成功，实际上是因为忘了在export里面加入import的函数。

错误的例子：

export('myFun','hello')
importFrom('GenomeInfoDb', 'genomeStyles')

正确的例子：

export('myFun','hello', 'genomeStyles')
importFrom('GenomeInfoDb', 'genomeStyles')

tips:
R studio中多行注释快捷键：cmd+shift+C