スキップしてメイン コンテンツに移動

Rでオブジェクト指向プログラミング: S4クラスの定義

第5回目です。いよいよコードを読んできます。

ファイルの配置とS4クラス・メソッドの定義の関係


Rディレクトリにこのパッケージのソースが含まれています。各々のファイルをみてきましょう。

[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
[/code]

まず、すべてのクラス定義は R/AllClasses.R に含めることがわかります。また、すべての総称関数 (Generic function) の定義は、R/AllGenerics.R に含めます。総称関数のコードは、R/メソッド名-methods.R という名前にします。オブジェクトの変数にアクセスする、いわゆる accessor method は R/クラス名-accessors.R に集めます。

これらはこのようにしなければ動作しないというわけではありませんが、BioC ではこのような構造で実装することが推奨されています (Bioconductor パッケージガイドライン: S4 クラスとメソッドを参照)。

GOstats の場合もこの構造に則って実装されていますね。ファイル名をみると、hyperGTest-methods.R と GOHyperGResult-accessors.R があります。ファイル名から、このパッケージは、GOHyperGResult というクラスと、hyperGTest という総称関数を持っていることがわかります。

S4クラスの定義


では、実際にそのクラスどのように定義されているか見てみましょう。

AllClasses.R
[code]
setClass("GOHyperGResult",
contains="HyperGResultBase",
representation=representation(
goDag="graph",
pvalue.order="integer",
conditional="logical"),
prototype=prototype(
testName="GO",
pvalueCutoff=0.01,
goDag=new("graphNEL")))
[/code]

わずかこれだけです。setClass でクラスを定義します。このエントリを読むひとは S4 の知識がありそうなものですが、一応、setClass を簡単に説明しておきます。

representation メソッドはクラスの持つ変数を定義します。この変数を S4 では slot と呼びます。slot 名 = "データ型" のリストが引数になります。S4ではこのようにデータ型を指定し、インスタンスを作成したときに型が違うとエラーを出します。

prototype はインスタンスが作られたときに引数が与えられなかった場合にデフォルトで slot に代入される値を決めています。

S4 クラスの拡張


contains はスーパークラスを指定します。GOHyperGResult は HyperGResultBase クラスのサブクラスになります。つまり、HyperGResultBase で定義された slot をすべて引き継ぎます。では、HyperGResultBase はどこで定義されているのでしょうか。grep します。

[code]
pwd
/Users/itoshi/Projects/Rpacks-devel
grep HyperGResultBase */R/*
Category/R/AllClasses.R:setClass("HyperGResultBase",
:
:
[/code]
ありました。

Category/R/AllClasses.R
[code]
setClass("HyperGResultBase",
representation(annotation="character",
geneIds="ANY",
testName="character",
pvalueCutoff="numeric",
testDirection="character"),
contains="VIRTUAL",
prototype=prototype(pvalueCutoff=0.01))

[/code]

サブクラスである、HyperGResult は、で定義された slot である、geneIds, testName, pvalueCutoff, testDirection を持つことになります。

バーチャルクラス


HyperGResultBase の contains が VIRTUAL となっています。これは virtual class を定義する方法のひとつです。virtual class はインスタンスを作れないクラスのことです。このことから、HyperGResultBase が直接使われることはなく、subclass を定義して使うためにあること、HyperGResult 以外にも HyperGResultBase 以外のサブクラスがありそうなことが予想がつきます。

[code]
grep HyperGResultBase */R/*.R|grep contains
Category/R/AllClasses.R: contains="HyperGResultBase",
Category/R/AllClasses.R: contains="HyperGResultBase",
GOstats/R/AllClasses.R: contains="HyperGResultBase",
PCpheno/R/AllClasses.R: contains="HyperGResultBase",
eisa/R/AllClasses.R: contains=c("HyperGResultBase", "VIRTUAL"),
[/code]

PCpheno と eisa で使っているようです。

このようにバーチャルクラスとクラスの拡張を使うことで、ほとんど同じであるがわずかに representation が違うクラスを定義しているわけです。

まとめ


S4クラスや総称関数の定義をどこに置くのかをみました。また S4 でクラスを定義する方法とクラスを継承し拡張する方法を簡単に紹介しました。

次は、メソッドの定義を見ていきましょうかね。

続きます。

連載の目次


第1回: Bioconductor のパッケージについて知る
第2回: Bioconductor のソースコードを得る
第3回: Bioconductor には S4 で書かれたコードがどのぐらいあるのか
第4回: R package の構造

コメント

このブログの人気の投稿

DNAを増幅するサーマルサイクラーを自作してみたよ

DNAをPCR法で増幅するために必要なサーマルサイクラーを自作してみました。自作と言っても、いわゆる、PCの自作と同じでパーツを組み立てていく感じです。購入から組み立ての様子を簡単に紹介します。モチベーション ラボには様々なレクリエーションがあります。例えば、単にどこかに遊びに行ったり、スポーツ大会したり、ひたすら合宿形式でプログレスのプレゼンをするミーティングするなどがあります。それもよいのですが、せっかくなので、普段の研究時間ではトライできないが、研究に関わる hack を行う、というイベントを企画してみました。夏休みの自由研究や社会科見学的なノリです。 うちのラボでは、PCRを使ったウェットの実験技術の開発をしてきました。しかし、サーマルサイクラーのハードウェアの仕組みを体験的に理解している訳ではありません。そこで、サーマルサイクラーを作ってみました。 欧米で始まっている、自宅のガレージやキッチンでバイオロジーを行うムーブメント、バイオパンク、DIYbio を体験しておきたいというのもありますし、Arduino などオープンハードウェア、Maker のムーブメントを体験するのも目的の一つです。ハードウェア開発が思っているほどハードルが下っていることを体験できて、かつ、将来、ウェットの開発だけでなく、装置開発などもできたら、ラッキー、ぐらいの気持ちでやってみました。 購入 今回作ったのは、組み立て式で、かつ、仕様などや設計図が公開されているOpenPCRというサーマルサイクラーです。ハードウェアの仕様・設計図、制御ソフトウェアなどの情報がすべて公開されており、部品からも自作することが可能です。今回は、「設計図から部品や回路のパーツを作り、それらを組み立てる直前のもの」を購入しました。 ChaiBio https://www.chaibio.com/ OpenPCR https://www.chaibio.com/products/openpcr なぜか http://openpcr.org/ で購入できなかったので、eBay にある ChaiBio で買いました。 OpenPCR - eBay http://www.ebay.com/itm/111096418574 本体価格は $599 で、送料が $76.05 で、輸入費用が $41.55 でした。合計 $716.6 だったので、日…

シーケンスアダプタ配列除去ツールまとめ

FASTQ/A file からシーケンスアダプター配列やプライマー配列を除くためのプログラムをまとめてみる。

まず、配列の除去には大別して2つの方向性がある。ひとつは、アダプター配列を含む「リード」を除いてしまう方法。もうひとつは除きたい配列をリードからトリムする方法である。後者のほうが有効リードが増えるメリットが、綺麗に除ききれない場合は、ゲノムへのマップ率が下がる。
気をつける点としては、アダプター/プライマーの reverse complement を検索するかどうか。paired end の際には大事になる。クオリティでトリムできるものや、Paired-end を考慮するものなどもある。アダプター/プライマー配列の文字列を引数として直接入力するものと、multi fasta 形式で指定できるももある。

From Evernote: シーケンスアダプタ配列除去ツールまとめTagDust
http://genome.gsc.riken.jp/osc/english/software/src/nexalign-1.3.5.tgz http://bioinformatics.oxfordjournals.org/content/25/21/2839.full
インストール: curl -O http://genome.gsc.riken.jp/osc/english/software/src/tagdust.tgztar zxvf tagdust.tgz cd tagdust/ make sudo make install rehash
使いかた: tagdust adapter.fasta input.fastq -fdr 0.05 -o output.clean.fastq -a output.artifactual.fastq
解説: 入出力形式は fastq/a が使える。リード全体を除く。速い。アダプター配列を fasta 形式で入力できるのが地味に便利で、これに対応しているものがなかなかない。Muth–Manber algorithm (Approximate multiple string search) を利用。FDRを指定できる。GPL3

もうひとつの Nikaido Lab. が始動します

ろくに更新していないこのブログで公表するものどうかと思いましたが、SNS以外で個人の立場として近況を書けるところはここだけなので、ここに書きます。

2020年4月1日より、国立大学法人 東京医科歯科大学難治疾患研究所 ゲノム応用医学部門 ゲノム機能情報分野の教授職を拝命致しました。東京医科歯科大学 大学院医歯学総合研究科 修士課程 医歯理工保健学専攻/博士課程 生命理工医療科学専攻 ゲノム機能情報の教授も兼務し、教育にも従事します。理研のラボも残しつつ2組織3拠点体制で研究、それに教育に励んでいきます。

両方で研究をすることを許して頂いた理研と大学の関係各位に深く御礼を申し上げます。またPI不在が多くなるにも関わらず、いろいろと工夫してラボ運営や研究に参加してくれている理研のメンバーにも大変感謝しています。また事前にお知らせしたかった方々も大勢おりましたが、ばたばたしており直接お話できずに申し訳ありません。

ゲノム分野の新しいバイオインフォマティクス技術は、ゲノム科学の新しい計測技術の側に現れます。その理由は新しいデータには新しいデータ科学の課題があるからです。そのデータの側にいればまっさきにアクセスできオリジナリティを発揮しやすくなります。しかし、それだけではありません。そもそも、データをどのように出すべきなのか、あるいは、データ解析技術を前提すれば新しい計測技術が作れないか(計算と計測の融合)、という1歩、2歩と踏み込んだバイオインフォマティクスとゲノム科学の関係が最先端の研究現場にはあります。このようにして生み出された技術は、新しい生命現象を観測し解き明かし、やがては疾患の理解や制御、診断に役に立つでしょう。

理研ではこのような立場から新しい1細胞RNA-seq法とそのデータ解析技術を開発し、社会実装もしてきました。これは異なるタレントの研究者が揃って共同し生み出せたものです。しかし、アイディアの量に対して人材は常に少ない状況です。また大きなプロジェクト(と家庭と任期)を抱えている研究員では、なかなか気軽にいろいろなことを試すのが難しい状況もあります。このような背景から、研究速度や規模が圧倒的に速くなっているゲノム科学やそのバイオインフォマティクス研究で、国際的な存在感を出すことが難しくなっています。

ここ数年は、このような研究に興味を持ち参加してくれる人を…