Bioconductor向けのパッケージの作成

Bioconductor はマイクロアレイや次世代シーケンサー解析などの手法を提供している R のパッケージを管理している。BioPerl や BioPython などに似ている。以下に Bioconductor 向けのパッケージの作成手順を示す。

パッケージの作成

Bioconductor 向けのパッケージも基本的に R のパッケージであるから、まずは、R のパッケージを作成する(参照:R のパッケージの作り方)。パッケージを作成するにあたって、いくつかの決まりごとがあり、重要なものだけを以下にリストアップした。これ以外の規則はBioconductor Developerのサイトで参照できる。

コーディングスタイル

  • 1 行は可能な限り 80 文字以内にする。コードファイルのみならず、NAMESPACE、DESCRIPTION、man、vignatte などのファイルも可能な限り 1 行 80 文字いないにする。
  • カンマの後にスペースを一つ入れる。
  • 演算子の前後にスペースを一つずつ入れる。
  • 1 行分全部コメントである場合は ## を先頭にする。
  • その他

必要事項

  • 一般の R のパッケージには必須ではないが、Bioconductor パッケージの場合は vignette は必須。
  • 依存パッケージがある場合、Depends、Imports、Suggests、Enhances などを正確に利用して継承する。
  • エラーチェック R CMD check の実行時間を 5 分以内に抑える(個人 PC 上で 5 分を超えても問題ない)。
  • エラーチェック R CMD check の結果はエラーがゼロ件、警告がゼロ件である必要がある。
  • クラスを定義した場合、show メソッドも合わせて定義する。
  • メッセージを出力するときは messagewarning を利用する。実行を中止させるときは stop を利用する。

サブミット

パッケージを作成し、R CMD check を実行して問題がないであれば、Bioconductor のスタッフに連絡する。連絡先は Bioconductor package submission のページの最下部にメールアドレスがある。そのアドレスに、Bioconductor へ投稿したいという内容でメールする。

何日かすると、Bioconductor tracker に登録してからパッケージをアップするように、と連絡が来る。メール本文中の URL にアクセスして、アカウントを作成し、指示された通りにパッケージをアップロードする。

Bioconductor 側の自動ビルドシステムによって、パッケージのエラーチェックが行われる。それから、おおよそ 2 週間ぐらいすると、パッケージのコード審査が始まる。さらに 1 週間ぐらいすると、メールでリバイスを受ける。

メールで指示された点を修正して、再度メール中で指示された方法でパッケージを再度アップロードする。2、3 日で再審査され、問題がなければアクセプトになる。

パッケージがアクセプトされた後に tracker システムはもう利用しない。

svn への追加

アクセプトされると、Bioconductor devel のレポジトリに追加される。Bioconductor のスタッフが追加作業を行う。追加後、そのことがメールで通知される。同時に、devel のレポジトリ上でパッケージを更新を行うためのアカウントとパスワードが発行される。

これ以降、通知されたアカウントとパスワードを用いて svn コマンドで、パッケージの管理を行う。

Bioconductor devel レポジトリに登録されてもすぐには Bioconductor devel のページで確認できない。自動ビルドシステムがチェックするまで、表示されない。2-3 日かかると考えたほうがよい。

パッケージのリリース

Bioconductor の devel レポジトリに取り込まれると、あとは devel レポジトリのファイルを更新していけばよい。4 月と 10 月の中旬に devel レポジトリにあるパッケージは release レポジトリに移行されそのままリリース版になる。