第4回目は、Rのパッケージの構造について書きます。
まず、読んでいくコードですが、Bioconductor のなかからGOstats を選びました。これはある遺伝子セットに有意に assign される Gene Ontology を発見するためのパッケージです。機能の詳細は vignette を読んでください。
1. Pure R
2. S4で書かれている
3. RUnit によるユニットテストがついている
4. コードが短い (952行)
5. Rの開発者(というか創始者)であり、BioC developer core team のメンバーである R. Gentleman がメインで開発・メンテしているっぽいので、コードが綺麗なはず。
ではパッケージの中身を覗いてみます。
[code]
tree GOstats
GOstats/
|-- DESCRIPTION
|-- NAMESPACE
|-- R
| |-- AllClasses.R
| |-- AllGenerics.R
| |-- GOHyperGResult-accessors.R
| |-- GOgraph.R
| |-- GOhyptest.R
| |-- hyperGTest-methods.R
| |-- hyperGtable.R
| |-- shortestPath.R
| |-- triad.R
| `-- zzz.R
|-- data
| |-- Bdists.rda
| `-- Ndists.rda
|-- inst
| |-- CITATION
| |-- Scripts
| | |-- TESTP.R
| | `-- distance.R
| |-- UnitTests
| | |-- Makefile
| | |-- ghgans10.rda
| | |-- hyperGTest_test.R
| | |-- runall.sh
| | |-- runalltests.R
| | `-- runfile.sh
| `-- doc
| |-- GOstats.bib
| |-- GOstatsForUnsupportedOrganisms.Rnw
| |-- GOstatsHyperG.Rnw
| |-- GOvis.Rnw
| |-- mygraph.jpg
| |-- old
| | `-- GOstats.Rnw
| `-- pco2
`-- man
|-- GOHyperG.Rd
|-- GOHyperGResult-class.Rd
|-- GOLeaves.Rd
|-- GOstats-defunct.Rd
|-- GOstats-package.Rd
|-- Ndists.Rd
|-- compCorrGraph.Rd
|-- compGdist.Rd
|-- hyperGTest.Rd
|-- idx2dimnames.Rd
|-- makeGOGraph.Rd
|-- notConn.Rd
|-- oneGOGraph.Rd
|-- probeSetSummary.Rd
|-- shortestPath.Rd
|-- simLL.Rd
|-- termGraphs.Rd
`-- triadCensus.Rd
8 directories, 48 files
[/code]
前回紹介した DESCRIPTION と NAMESPACE はディレクトリのトップに配置されています。そのほかのディレクトリですが、
R: ライブラリの本体。ソースコードが含まれている
inst: パッケージがインストールされるときにコピーされるファイル群
data: デモのデータ
man: help コマンドで表示されるマニュアルが Rd 形式で配置される
のようになっています。今回はコードを読むのが目的なのでパッケージ構造の話はこのぐらいにしておきます。詳しくは、Writing R Extensions: 1.1 Package structureにあります。
次回こそコードを読みます。
続きます。
第1回: Bioconductor のパッケージについて知る
第2回: Bioconductor のソースコードを得る
第3回: Bioconductor には S4 で書かれたコードがどのぐらいあるのか
まず、読んでいくコードですが、Bioconductor のなかからGOstats を選びました。これはある遺伝子セットに有意に assign される Gene Ontology を発見するためのパッケージです。機能の詳細は vignette を読んでください。
なぜこのパッケージを読むのか
1. Pure R
2. S4で書かれている
3. RUnit によるユニットテストがついている
4. コードが短い (952行)
5. Rの開発者(というか創始者)であり、BioC developer core team のメンバーである R. Gentleman がメインで開発・メンテしているっぽいので、コードが綺麗なはず。
パッケージの構造
ではパッケージの中身を覗いてみます。
[code]
tree GOstats
GOstats/
|-- DESCRIPTION
|-- NAMESPACE
|-- R
| |-- AllClasses.R
| |-- AllGenerics.R
| |-- GOHyperGResult-accessors.R
| |-- GOgraph.R
| |-- GOhyptest.R
| |-- hyperGTest-methods.R
| |-- hyperGtable.R
| |-- shortestPath.R
| |-- triad.R
| `-- zzz.R
|-- data
| |-- Bdists.rda
| `-- Ndists.rda
|-- inst
| |-- CITATION
| |-- Scripts
| | |-- TESTP.R
| | `-- distance.R
| |-- UnitTests
| | |-- Makefile
| | |-- ghgans10.rda
| | |-- hyperGTest_test.R
| | |-- runall.sh
| | |-- runalltests.R
| | `-- runfile.sh
| `-- doc
| |-- GOstats.bib
| |-- GOstatsForUnsupportedOrganisms.Rnw
| |-- GOstatsHyperG.Rnw
| |-- GOvis.Rnw
| |-- mygraph.jpg
| |-- old
| | `-- GOstats.Rnw
| `-- pco2
`-- man
|-- GOHyperG.Rd
|-- GOHyperGResult-class.Rd
|-- GOLeaves.Rd
|-- GOstats-defunct.Rd
|-- GOstats-package.Rd
|-- Ndists.Rd
|-- compCorrGraph.Rd
|-- compGdist.Rd
|-- hyperGTest.Rd
|-- idx2dimnames.Rd
|-- makeGOGraph.Rd
|-- notConn.Rd
|-- oneGOGraph.Rd
|-- probeSetSummary.Rd
|-- shortestPath.Rd
|-- simLL.Rd
|-- termGraphs.Rd
`-- triadCensus.Rd
8 directories, 48 files
[/code]
前回紹介した DESCRIPTION と NAMESPACE はディレクトリのトップに配置されています。そのほかのディレクトリですが、
R: ライブラリの本体。ソースコードが含まれている
inst: パッケージがインストールされるときにコピーされるファイル群
data: デモのデータ
man: help コマンドで表示されるマニュアルが Rd 形式で配置される
のようになっています。今回はコードを読むのが目的なのでパッケージ構造の話はこのぐらいにしておきます。詳しくは、Writing R Extensions: 1.1 Package structureにあります。
次回こそコードを読みます。
続きます。
連載の目次
第1回: Bioconductor のパッケージについて知る
第2回: Bioconductor のソースコードを得る
第3回: Bioconductor には S4 で書かれたコードがどのぐらいあるのか
コメント
コメントを投稿