--- bioruby-1.1.0.orig/doc/BioRuby.rd.ja +++ bioruby-1.1.0/doc/BioRuby.rd.ja @@ -0,0 +1,225 @@ +=begin + + $Id: BioRuby.rd.ja,v 1.10 2004/08/23 23:41:29 k Exp $ + + Copyright (C) 2001, 2002 KATAYAMA Toshiaki + += BioRuby プロジェクト + +BioRuby は、Bioinformatics で必要とされる、データベースの検索、データの +取得とパース、配列解析からパスウェイ解析まで様々な計算、などに必要となる +様々な機能を Ruby 言語で実装し、簡単に扱えるようにするプロジェクトです。 + +他の先行プロジェクトとしては BioPerl, BioPython, BioJava など様々なもの +があります。完成度では歴史の長い BioPerl が最も充実していると思いますが、 +BioPerl は配列主体の複雑な構造で、データセンターでの利用が主に想定されて +いるように思えますし、そもそも Perl で複雑なデータ構造を扱うとソースコー +ドが読みづらくなります。この結果、メンテナンスや改良が難しくなります。他 +のプロジェクトにもそれぞれ利点があると思いますが、いずれにしても後発で開 +発の途中段階にあることを考えれば、自分の使いやすい言語で必要な機能を実装 +して行っても十分に追い付けると思います。 + +BioRuby では、シンプルで強力な Ruby 言語のアドバンテージを生かし、分かり +やすいコードでエンドユーザに必要な機能を実装していきたいと思います。特に +Ruby のあらゆるオブジェクトという発想は、モノを扱う生物学にも素直に当て +はめやすいコンセプトですし、トライ＆エラーで作業を進める事ができるインター +プリタ言語は C や Java と比べてウェットなラボの研究者にも馴染みやすいと +思います。 + +また、Ruby では Perl 譲りの強力な文字列処理に加え、Perl の後づけの OO に +よるオマジナイや、頻出する local, my などが不要で、複雑なデータ構造もク +ラスですっきりと表現できるため、本質的な部分に専念してコーディングするこ +とができます。これにより、開発の効率も高くなるため、他のプロジェクトが手 +掛けていない領域にもいち早く取り組んでいけると思います。 + +さらに、Ruby 自体が日本で開発された言語であるのに加え BioRuby も日本初の +オープンな Bio* プロジェクトです。このため、情報が日本語で得られ、開発も +日本語で行なえる点、KEGG など日本独自のシステムへの対応なども行ないやす +い点も BioRuby のメリットでしょう。 + +BioRuby のウェブサイト (()) で、最新のお知らせ、 +ソースの入手方法、メーリングリストなどの情報と、他のドキュメントやコメン +トなどの情報が得られます。 + +== 使い方 + +BioRuby を使うスクリプトの中で + + require 'bio' + +としてください。 + +全てのクラスは module Bio の下に追加されますが、必要に応じて + + include Bio + +とすることで、Bio:: を省いて各クラスを使う事ができます。 + +== BioRuby の概略 + +bio.rb を require すると、以下のクラスや定数などが使えるようになります。 +現在実装されている主な機能は、 + +* アミノ酸配列や塩基配列の、翻訳やウィンドウサーチなどを含む操作、 + スプライシングなどを表す GenBank 形式の location フォーマットの処理 +* BLAST/FASTA などを用いた相同性検索 +* ゲノムネット (()) の検索とデータ取得 +* GenBank や KEGG など様々なデータベースの細かいパース +* PubMed/MEDLINE などの引用文献データの取得と整形 +* パスウェイ解析に必要なグラフと２項関係の操作 + +などです。詳しい使用方法については、個々のクラスに関するドキュメントや、 +チュートリアルを参照して下さい。 + +他に、まだ未統合ですが C 言語による、クラスタリングや Smith-Waterman ア +ルゴリズムの実装なども行なわれています。 + +=== クラス階層 + + class Object ファイル レベル + |- class String + | `- class Bio::Sequence bio/sequence.rb stable + | |- class Bio::Sequence::AA bio/sequence.rb stable + | `- class Bio::Sequence::NA bio/sequence.rb stable + |- class Bio::Location bio/location.rb stable + |- class Bio::Locations bio/location.rb stable + |- class Bio::Feature bio/feature.rb stable + |- class Bio::Features bio/feature.rb stable + |- class Bio::Reference bio/reference.rb stable + |- class Bio::References bio/reference.rb stable + |- class Bio::Pathway bio/pathway.rb stable + |- class Bio::Relation bio/pathway.rb stable + |- class Bio::FlatFile bio/io/flatfile.rb stable + |- class Bio::Registry bio/io/registry.rb beta + |- class Bio::Fetch bio/io/fetch.rb stable + |- class Bio::SQL bio/io/sql.rb beta + |- class Bio::DBGET bio/io/dbget.rb stable + |- class Bio::PubMed bio/io/pubmed.rb stable + |- class Bio::BRDB bio/io/brdb.rb alpha + |- class Bio::Fasta bio/appl/fasta.rb stable + |- class Bio::Fasta::Report::* bio/appl/fasta/*.rb stable + |- class Bio::Blast bio/appl/blast.rb stable + |- class Bio::Blast::Report::* bio/appl/blast/*.rb stable + |- class Bio::DB bio/db.rb stable + | |- class Bio::FastaFormat bio/db/fasta.rb stable + | |- class Bio::NCBIDB bio/db.rb stable + | | |- class Bio::GenBank bio/db/genbank/genbank.rb stable + | | | |- class Bio::GenPept bio/db/genbank/genpept.rb stable + | | | |- class Bio::RefSeq bio/db/genbank/refseq.rb stable + | | | `- class Bio::DDBJ bio/db/genbank/ddbj.rb stable + | | |- class Bio::MEDLINE bio/db/medline.rb stable + | | |- class Bio::LITDB bio/db/litdb.rb stable + | | `- class Bio::KEGGDB bio/db.rb beta + | | |- class Bio::AAindex bio/db/aaindex.rb beta + | | | |- class Bio::AAindex1 bio/db/aaindex.rb beta + | | | `- class Bio::AAindex2 bio/db/aaindex.rb beta + | | |- class Bio::KEGG::GENES bio/db/kegg/genes.rb stable + | | |- class Bio::KEGG::GENOME bio/db/kegg/genome.rb stable + | | |- class Bio::KEGG::BRITE bio/db/kegg/brite.rb alpha + | | |- class Bio::KEGG::CELL bio/db/kegg/cell.rb beta + | | |- class Bio::KEGG::ENZYME bio/db/kegg/enzyme.rb alpha + | | `- class Bio::KEGG::COMPOUND bio/db/kegg/compound.rb alpha + | `- class Bio::EMBLDB bio/db.rb stable + | |- class Bio::EMBL bio/db/embl/embl.rb beta + | |- class Bio::SPTR bio/db/embl/sptr.rb beta + | | |- class Bio::SwissProt bio/db/embl/swissprot.rb beta + | | `- class Bio::TrEMBL bio/db/embl/swissprot.rb beta + | |- class Bio::PROSITE bio/db/prosite.rb beta + | `- class Bio::TRANSFAC bio/db/transfac.rb beta + | |- class Bio::TFMATRIX bio/db/transfac.rb beta + | |- class Bio::TFSITE bio/db/transfac.rb beta + | |- class Bio::TFFACTOR bio/db/transfac.rb beta + | |- class Bio::TFCELL bio/db/transfac.rb beta + | |- class Bio::TFCLASS bio/db/transfac.rb beta + | `- class Bio::TFGENE bio/db/transfac.rb beta + |- class Bio::KEGG::DBname bio/db/kegg/keggtab.rb beta + |- class Bio::KEGG::Keggtab bio/db/kegg/keggtab.rb beta + |- class Bio::KEGG::Microarray bio/db/kegg/microarray.rb alpha + `- class Bio::KEGG::Microarrays bio/db/kegg/microarray.rb alpha + +=== 標準クラスへのメソッド追加 + + class Matrix bio/matrix.rb alpha + class Vector bio/matrix.rb alpha + class String bio/extend.rb beta + class Array bio/extend.rb beta + +=== 定数と名前空間の階層 + + module Bio ファイル タイプ + |- AAindex bio/db/aaindex.rb class + |- AAindex1 bio/db/aaindex.rb class + |- AAindex2 bio/db/aaindex.rb class + |- AminoAcid bio/data/aa.rb constant + |- AminoAcid_weight bio/data/aa.rb constant + |- BIORUBY_VERSION bio.rb constant + |- Blast bio/appl/blast.rb class + | `- Report::* bio/appl/blast/*.rb class + |- BRDB bio/io/brdb.rb class + |- CodonTable bio/data/codontable.rb constant + |- DB bio/db.rb class + |- DBGET bio/io/dbget.rb class + |- DDBJ bio/db/genbank/ddbj.rb class + |- EMBL_COMMON bio/db/embl.rb module + |- EMBL bio/db/embl/embl.rb class + |- EMBLDB bio/db.rb class + |- Fasta bio/appl/fasta.rb class + | `- Report::* bio/appl/fasta/*.rb class + |- FastaFormat bio/db/fasta.rb class + |- FastaNumericFormat bio/db/fasta.rb class + |- Fetch bio/io/fetch.rb class + |- FlatFile bio/io/flatfile.rb class + |- GENBANK_COMMON bio/db/genbank.rb module + |- GenBank bio/db/genbank/genbank.rb class + |- GenPept bio/db/genbank/genpept.rb class + |- KEGG bio/db/kegg/ class + | |- BRITE bio/db/kegg/brite.rb class + | |- CELL bio/db/kegg/cell.rb class + | |- COMPOUND bio/db/kegg/compound.rb class + | |- ENZYME bio/db/kegg/enzyme.rb class + | |- GENES bio/db/kegg/genes.rb class + | |- GENOME bio/db/kegg/genome.rb class + | |- Keggtab bio/db/kegg/keggtab.rb class + | |- DBname bio/db/kegg/keggtab.rb class + | |- Microarray bio/db/kegg/microarray.rb class + | `- Microarrays bio/db/kegg/microarray.rb class + |- KEGGDB bio/db.rb class + |- KEGGORG bio/data/keggorg.rb constant + |- LITDB bio/db/litdb.rb class + |- Location bio/location.rb class + |- Locations bio/location.rb class + |- MEDLINE bio/db/medline.rb class + |- NCBIDB bio/db.rb class + |- NucleicAcid bio/data/na.rb constant + |- NucleicAcid_weight bio/data/na.rb constant + |- Pathway bio/pathway.rb class + |- PROSITE bio/db/prosite.rb class + |- PubMed bio/io/pubmed.rb class + |- Reference bio/reference.rb class + |- RefSeq bio/db/genbank/refseq.rb class + |- Registry bio/db/registry.rb class + |- Relation bio/pathway.rb class + |- Seq bio/sequence.rb class + | |- AA bio/sequence.rb class + | `- NA bio/sequence.rb class + |- Sequence bio/sequence.rb class + | |- AA bio/sequence.rb class + | `- NA bio/sequence.rb class + |- SwissProt bio/db/embl/swissprot.rb class + |- SPTR bio/db/embl/sptr.rb class + |- SQL bio/io/sql.rb class + |- TFCELL bio/db/transfac.rb class + |- TFCLASS bio/db/transfac.rb class + |- TFFACTOR bio/db/transfac.rb class + |- TFGENE bio/db/transfac.rb class + |- TFMATRIX bio/db/transfac.rb class + |- TFSITE bio/db/transfac.rb class + |- TRANSFAC bio/db/transfac.rb class + `- TrEMBL bio/db/embl/trembl.rb class + +=== ファイル階層 + +BioRuby のファイル構成については Design.rd.ja を参照してください。 + +=end + --- bioruby-1.1.0.orig/doc/Design.rd.ja +++ bioruby-1.1.0/doc/Design.rd.ja @@ -0,0 +1,341 @@ +=begin + + $Id: Design.rd.ja,v 1.7 2002/07/02 01:40:24 k Exp $ + + Copyright (C) 2001 KATAYAMA Toshiaki + += BioRuby の開発方針とデザイン + +新しくモジュールを追加する場合は CVS の以下のレポジトリに、内容に従って +適切に commit します。メーリングリストなどで contribute されたコードは +本人に committer になってもらうか、スタッフが commit します。 + + bioruby/ + |-- README はじめに + |-- install.rb インストーラ + |-- COPYING + |-- COPYING.LIB + |-- bin/ アプリケーション + |-- lib/ Ruby で書かれたライブラリ + | `-- bio/ 配列など基本的なクラス + | |-- data/ 生物学的な定数などデータそのもの + | |-- db/ 各種データベースパーザ + | |-- io/ データの入出力 + | `-- appl/ 外部アプリの処理 + |-- doc/ ドキュメント + |-- ext/ C で書かれたライブラリ + `-- sample/ サンプルコード + +== Ruby 部分についてのデザイン（bioruby/lib/bio/ 以下） + +これまでに行なわれた実装のデザインコンセプトと、今後の方針などについてま +とめておきます。 + +BioRuby の全クラスは module Bio で囲むことで、名前空間を切り分ける事にし +ます。 + +=== lib/bio/ データ構造系 + +塩基やアミノ酸の配列、文献情報、遺伝子の location や feature、グラフなど +の抽象データ構造を扱うクラスは lib/bio/ 直下に配置しています。これらは各 +データベース・パーザなどからも直接呼ばれます。 + +他に、アライメントクラスなどの実装が必要かも知れません。また、生物種の系 +統分類を表す Taxonomy クラスや GeneOntology などのクラスもあると便利かも +知れません。 + +=== lib/bio/db/ データベース・パーザ系 + +使い方の簡単さ vs 実装の複雑さ、処理の早さ vs メモリの重さ、などバランス +の問題で必ずしも良いとは言えない場合もありますが、lib/bio/db.rb では以下 +のような独自のアイデア（すでに同様な試みがなされていたかどうかは調べてい +ません）を採用しています。新しくパーザを追加する場合も参考にして下さい。 + + エントリ それぞれのデータベースにおける１つのデータ単位 + 例) GenBank なら LOCUS から // までの全ての行 + デリミタ エントリとエントリを区切る文字列 + 例) GenBank なら // だけの行 + タグ エントリの左端数カラムなどに記されるトップレベルの識別子 + 例) GenBank なら DEFINITION や FEATURES など + フィールド タグ毎に意味のある単位をなす複数行からなるブロック + 例) GenBank なら SOURCE に含まれる taxonomy までの行全部など + +BioRuby のデータベース・パーザは、１エントリ分の文字列を .new に渡す事で +パースした結果を保持するインスタンスを返すデザインになっています。各デー +タベースからエントリ単位のデータを得る方法は、手元のフラットファイルを使 +う場合、ネット越しに DBGET や BioFetch した場合、NCBI から取ってきた場合、 +など使い方によって様々ですが、どこからエントリを得たか (io) に関わらず、 +パーザはエントリをパースする処理に専念できます。 + +最終的には全てのデータはあらかじめパースして tab 切りのデータに切り刻み、 +MySQL などに突っ込んでしまってパースの必要がないような世界にしたいです。 +BioPerl の BioPerl-DB に似ていると思いますが、BioRuby 標準の DataBase と +いうことで BioRuby-DB (class BRDB) として開発を進めています。BioRuby プ +ロジェクトも BioHackathon や BOSC に参加して OBDA の BioSQL などに準拠す +るようになりましたので、今後は独自データベースが必要な部分は減っていくか +もしれません。 + + * OBDA : Open Bio Sequence Database Access + * (()) + * (()) + * BOSC : Bioinformatics Open Source Conference + * (()) + ++ データベース構造の抽象化 + +lib/bio/db/ 以下のモジュールは、lib/bio/db.rb を require し、少なくとも +DB クラスを継承します。さらに、いくつかのデータベースは類似の構造を持っ +ているため、とりあえず NCBI 型（KEGG も含む）、EMBL 型に分けて、パースの +際に共通で使えるメソッドを共有しようとしています。ただし、実際にはこれら +の形式に当てはまらないデータベースも多いので、DB だけを継承する場合もあ +るでしょう。 + ++ フィールドに対する共通の API を定義 + +様々なデータベースでよく共通して現れるようなフィールドに対しては、db.rb +内にあるドキュメントで示される共通のメソッド名を使って、データを取りだせ +るようにします。 + +このように、フィールドに対する共通のメソッド名が、各データベースのパーサ +で適切に実装されていれば、データベース毎にメソッドを覚える必要が減ります。 +例えば、データベースが異なっても「エントリの説明フィールド」取得のための +メソッドは definition だろうと推測しやすくなります。 + ++ 必要な時までパースを遅らせる（on-demand parsing） + +GenBank など複雑な構造のデータベースをパースする際にもスループットを良く +するため、最初はフィールド毎に切り分ける前処理だけを行ない、特定のフィー +ルド内のデータを要求するメソッドが呼ばれた時だけ実際にフィールド内のデー +タを細かくパースする処理を行ないます。もちろんこの時パースされるのは、必 +要なフィールドだけです。 + ++ 一度パースした結果はキャッシュしておく + +上記の on-demand parsing でパースした結果は、オブジェクト内にキャッシュ +しておくので、２度目以降のメソッドコールでは保持しているパース済みのデー +タを返します。これにより重いパースを繰り返すようなオーバーヘッドを無くし +ています。 + +=== lib/bio/data/ 定数、データ系 + +lib/bio/data/ 以下に、いくつかのデータ（アミノ酸の名前、KEGG での生物種 +名、コドン表など）が定数として置かれています。 + + Bio::AminoAcid → アミノ酸の名前を表すハッシュ、など + +これらは、必要なクラスにアクセスメソッドを定義しても良いでしょう。 + +=== lib/bio/io/ インターフェイス、IO 系 + +lib/bio/io/ 以下には、フラットファイル形式をエントリ単位で読み込むクラス、 +ゲノムネットからデータ取得を行なう DBGET クラスと NCBI の PubMed による +MEDLINE データ取得を行なう PubMed クラス、OBDA に準拠した BioRegistry, +BioFetch, BioSQL などによるデータ取得を行うクラスなどがあります。 + +* flatfile.rb （実装済） + + # ローカルのファイルを GenBank フォーマットとして開く + flatfile = Bio::FlatFile.open(Bio::GenBank, "genbank/gbest40.seq") + + # またはファイルは引数で与える + Bio::FlatFile.new(Bio::GenBank, ARGF) + + # または IO で与える + Bio::FlatFile.new(Bio::GenBank, IO.popen("gzip -dc nc1101.flat.gz")) + + # 最初のエントリを GenBank オブジェクトに + gb = flatfile.next_entry + + # エントリごとに Bio::GenBank オブジェクトを生成 + flatfile.each do |gb| + puts gb.definition + end + +=== lib/bio/appl/ ツール系 + +FASTA(SSEARCH), [PSI-]BLAST, HMMER, CLUSTALW などの外部アプリを使った処 +理を行います。ローカルな実行、http などによるリモート実行、結果のフォー +マットなどを意識せずに、結果がパースされ格納された Report オブジェクトな +どが返るような感じにしていきます。 + +* query となるオブジェクトに、アプリを実行するメソッドを実装（必要な引数 + を与える） + + factory = Bio::Fasta.remote('fasta', 'genes') + fa_res = f.fasta(factory) # f は Bio::FastaFormat オブジェクト + fa_res = seq.fasta(factory) # seq は Bio::Sequence::AA オブジェクトなど + +* 新しく生成したファクトリに、サーバ、query、target などを設定して、アプ + リを実行するメソッドを呼ぶ + + factory = Bio::Fasta.local(prog, target, opt) + fa_res = factory.query(seq) + +などいくつかの実装方法が考えられます（Bio::Fasta, Bio::Blast では両系統 +インプリしています）。 + +ファクトリやメソッドへのオプションの渡し方は、複雑な物はシンボルをキーに +した hash にした方が良いかもしれません。もしくは名前つき引数待ち？ + + res = a.query(:hoge => fuga, :hoge2 => fuga2) + +今後他のアプリのインターフェイスも実装しながら仕様を決めていきたいと思 +います。 + +== コーディングスタイル + +クラス設計、メソッド定義など全般において、KISS (keep it simple stupid) が +基本です。ただし、なんでもかんでも class に分解してしまえば良いわけでは +ないでしょう。概念として一つのまとまりだと思えるものまで分解すればよく、 +特に使い回しのきかないオブジェクトを生成する必要はないと思います。 + +技術的な事については、常に改善の余地があると思います。書き換える事により +シンプルで分かりやすくなる場合、今後の開発がスムーズになると思われる場合 +には、どんどん修正していきます。逆に、多少効率が良くなるとしても何をやっ +ているか分かりにくくなる場合、必要性が高いと思える積極的な理由が見つから +ない場合は採用を見合わせることもあると思います。いずれにしても、バージョ +ン 1.0 までは下位互換性を犠牲にした変更も行なう予定です。 + +ソースコード中には日本語など非 ASCII の文字列は含まないようにします。 + +=== ヘッダ部 + +ヘッダ部には、ファイル名、概要、著作権者、ライセンス、CVS の ID を書きます +（下の例では ID の＄を展開されないように全角にしていますが、実際は $ です）。 + + # + # bio/hoge.rb - biological hoge class + # + # Copyright (C) 2000, 2001 KATAYAMA Toshiaki + # + # This library is free software; you can redistribute it and/or + # modify it under the terms of the GNU Lesser General Public + # License as published by the Free Software Foundation; either + # version 2 of the License, or (at your option) any later version. + # + # This library is distributed in the hope that it will be useful, + # but WITHOUT ANY WARRANTY; without even the implied warranty of + # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + # Lesser General Public License for more details. + # + # You should have received a copy of the GNU Lesser General Public + # License along with this library; if not, write to the Free Software + # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + # + # ＄Id:＄ + # + +アプリケーションやサンプルコードを書く場合は、ruby のパスに依存しないよ +うに１行目を + + #!/usr/bin/env ruby + +のように始めるのも良いでしょう。 + +=== 本体 + +本体は module Bio で括り、必要なクラスを実装します。本体内では # を使っ +てコメントをつけ、RD を使ったコメントはファイルの最後のドキュメント部ま +では出てこないようにします。もし作成するクラスが bio/db/ 以下のデータベー +スパーザ系だったら、bio/db.rb のドキュメントも参照して下さい。 + + require 'foo/bar' + + modlue Bio + + class Hoge + + # this method do hogehoge + def hoge(fuga) + @fuga = fuga # storing data fuga + end + + def gege + end + + end + + end + +RDoc を使えばクラスやメソッドの上に書かれたコメントから HTML などを生成 +できるようです。今後 ri 用の出力もできるようになってきたら、採用するかも +しれません。 + +=== テストコード部 + +テストコードはクラス定義など本体部分のあとにをつけることにします。テスト +コードの書き方はこれから検討していく必要がありますが、とりあえず以下のよ +うな構文でテストコードを囲みます。 + + if __FILE__ == $0 + # test code here + end + +このおまじないのような構文は、ファイル hoge.rb がコマンドラインから + + % ruby hoge.rb + +などとスクリプトとして起動された場合に実行されますが、ライブラリとして + + require 'hoge' + +のようにロードされた場合には実行されないようにするための常套句です。 + +テストの方法は、Test::Unit が ruby の標準ライブラリとして添付されるよう +になれば採用してもいいと思いますが、それまでは色々試したいと思います。テ +ストに外部ファイルやネットワークなどが必要な場合どうするかとか、インストー +ル前に動作確認としてテストを実行する方法なども検討する必要があります。 + +=== ドキュメント部 + +これまで、各クラスについては、あまりドキュメント化されていませんでしたが、 +今後はテストコードのあと、ファイルの最後尾に RD でメソッドなどのドキュメ +ントを追加することにしていきます。 + + =begin + + = Bio::Hoge + + Hoge クラスの概要説明。 + + --- Bio::Hoge.new(fuga) + + クラスメソッドの説明。 + + --- Bio::Hoge#to_a + + メソッドの説明。 + + == Bio::Hoge::Fuga + + 内部クラス Hoge::Fuga の概要説明 + + --- Bio::Hoge::Fuga.new(fuga) + + クラスメソッドの説明。 + + --- Bio::Hoge::Fuga#to_a + + メソッドの説明。 + + =end + +ただし、 + +* ソースの中には ASCII 以外の文字を入れない方針のため、日本語のドキュメ + ントは、この部分ではなく別ファイルに記述し、doc/ ディレクトリ以下に置 + くなどします。この際、拡張子に .ja を付けて、ファイル名からも日本語と + 分かるようにします。 + +* 前述のように、ソースコード本体内では RD によるドキュメントは禁止します。 + 理由は純粋にコードが読みづらくなるからです。ソース中で # を使って必要 + なコメントを追加する事は歓迎します。(前述のように RDoc 準拠にするかも + しれません) + +== 開発に参加するには + +BioRuby のウェブサイト (()) を見て、メーリングリ +ストに参加するか、スタッフ に連絡してください。 + +=end + --- bioruby-1.1.0.orig/doc/TODO.rd.ja +++ bioruby-1.1.0/doc/TODO.rd.ja @@ -0,0 +1,138 @@ +=begin + + $Id: TODO.rd.ja,v 1.16 2004/08/24 00:18:03 k Exp $ + + Copyright (C) 2001, 2002 KATAYAMA Toshiaki + += TODO + +* 定期リリース + +* ドキュメント更新 + * チュートリアル追記 + * 英語化 + * RDoc + +* サンプル整理 (*2tab とか) + * sample/README.rd[.ja] + +* cvs.open-bio.org のドキュメント更新 + +* Bio::SQL update, name space + +* Bio::Fetch + * E-Utils + * http://www.ncbi.nlm.nih.gov/entrez/query/static/eutils_help.html + + +* Bio::Location location coordinate system (style) + +* GenBank, EMBL, SPTR, BioSQL の統合、フォーマット相互変換 + * genbank/ @moltype + * bio/db/seqentry.rb か bio/seqentry.rb あたりにコンテナ SeqEntry を作る + * InternalSeq とかでも？ + * lib/bio/db/genbank/, embl/ リファクタリング + * Bio::SQL::Sequence も含めた内部構造 + * genpept, refseq(NP_) + * Bio::Reference クラス → EMBL にも? + * test GenBank >350k + +* Blast, Fasta, Hmmer + * blast, hmmer のレポート -> Bio::FlatFile からもアクセス + * bio/appl/fasta/report.rb, bio/appl/hmmer/report.rb コンテナ括り出し + * lib/bio/appl/blast/xmlparser.rb " problem + * lib/bio/appl/megablast.rb 追加？ + * Blast HSP tiling [bioperl-l 2002 8/13,4,5 ?] + * Bio::Blast::Report::Hit#total_alignment_length + * Bio::Blast::Report::Hit#total_identical_residues + * Bio::Blast::Report::Hit#total_convserved_residues + +* MAFFT, T-Coffee, CLUSTALW → アラインメント + * アライメントオブジェクト + * class Bio::Alignment ? + * class Bio::Alignment::Pairwise or class Bio::PairwiseAlignment ? + * class Bio::Alignment::Multiple or class Bio::MultipleAlignment ? + * アライメントビューアもほしい + * Blast refactering + * AlignFactory -> SearchIO化 + * Bio::Align で Bio::Blast::Report などのアライメントを + 保持するのにつかう + * アラインメントクラスで CIGAR フォーマット + +* KGMLパーサ + * Pathwayクラスにdijkstra -> Graph + * Treeクラス + +* lib/bio/db/kegg/keggtab.rb と lib/bio/data/keggorg.rb の統合？ + +* Bio::LSID [bioperl-l 2002 7/15 seq namespace method] + +* コーディングスタイル + * camelCase 禁止 + * = の左右は空ける + * tab なし 2 スペースインデント + * 最終的には RDoc 付加？ (Rimport を使うのがいいかも) + * クラス名、モジュール名は camelCase、定数は大文字で _ で区切る + * Array, Hash以上にネストしたらクラスを作る方針 + +=== DB + +* オントロジー (GO etc.) 処理系 + +* モチーフ系 InterPro (incl. Pfam etc.) 処理系 + +* SSDB + +* COG + +* PDB or PDBj パーザ + * challange CASP? :) + +=== 全般 + +* Ruby 1.8 + * stringIO + * autoload + * Array.new(num) { Hoge.new } + +* ext/ + * 一部の遅いメソッド C 化 ? + +* ジョブをパラレル化するためのクラス + +* テスト環境の整備 + * Test::Unit 使う？ + * 外部ファイル、ネットワークがいる場合どうするか + * インストール時に make check みたいなことをするか + +* スレッド + * 今のところあまり使う場面はないかも知れないけど… GUI とかで？ + +* ドキュメント翻訳 + * Thai + * Korea + * Russia + * French + +== OTHERS + +* midi + +* q--p + * RSS + * tDiary + +* gb.bioruby.org で GFF, DAS 対応 + * ポスター作成アプリ（コマンドライン/CGI） + * Ming？ + +* R, SVM/RVM, グラフ 系 + +* Ruby/Cocoa, Ruby/Gtk による GUI なファクトリー + * gsequence + * biograph + * GO の xml と GtkTree → メモリ足りぬ… + +* 本 + +=end --- bioruby-1.1.0.orig/lib/bio/appl/fasta/format6.rb +++ bioruby-1.1.0/lib/bio/appl/fasta/format6.rb @@ -0,0 +1,37 @@ +# +# bio/appl/fasta/format6.rb - FASTA output (-m 6) parser +# +# Copyright (C) 2002 KATAYAMA Toshiaki +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# $Id: format6.rb,v 1.2 2005/09/08 01:22:09 k Exp $ +# + +module Bio + class Fasta + + class Report + + # will be ported from sample/{fasta2tab,ssearch2tab,tfastx2tab}.rb + + def initialize + raise NotImplementedError + end + end + + end +end + --- bioruby-1.1.0.orig/lib/bio/db/kegg/cell.rb +++ bioruby-1.1.0/lib/bio/db/kegg/cell.rb @@ -0,0 +1,88 @@ +# +# bio/db/kegg/cell.rb - KEGG/CELL database class +# +# Copyright (C) 2001 KAWASHIMA Shuichi +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# $Id: cell.rb,v 1.7 2005/09/08 01:22:11 k Exp $ +# + +require "bio/db" + +module Bio + + class KEGG + + class CELL < KEGGDB + + DELIMITER = RS = "\n///\n" + TAGSIZE = 12 + + def initialize(entry) + super(entry, TAGSIZE) + end + + def entry_id + field_fetch('ENTRY') + end + + def definition + field_fetch('DEFINITION') + end + + def org + field_fetch('ORGANISM') + end + alias organism org + + def mother + field_fetch('MOTHER') + end + + def daughter + field_fetch('DAUGHTER').gsub(/ /, '').split(/,/) + end + + def sister + field_fetch('SISTER') + end + + def fate + field_fetch('CELL_FATE').gsub(/ /, '').split(/,/) + end + + def contact + field_fetch('CONTACT').gsub(/ /, '').split(/,/) + end + + def expression + field_fetch('EXPRESSION') + end + + def fig + field_fetch('FIGURE') + end + + def ref + field_fetch('REFERENCE') + end + + end + + end + +end + --- bioruby-1.1.0.orig/lib/bio/db/kegg/ko.rb +++ bioruby-1.1.0/lib/bio/db/kegg/ko.rb @@ -0,0 +1,178 @@ +# +# bio/db/kegg/ko.rb - KO (KEGG Orthology) database class +# +# Copyright (C) 2003 KATAYAMA Toshiaki +# Copyright (C) 2003 Masumi Itoh +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# $Id: ko.rb,v 1.5 2005/09/08 01:22:11 k Exp $ +# + +require 'bio/db' + +module Bio + + class KEGG + + class KO < KEGGDB + + DELIMITER = RS = "\n///\n" + TAGSIZE = 12 + + def initialize(entry) + super(entry, TAGSIZE) + end + + + def entry_id + field_fetch('ENTRY')[/\S+/] + end + + def name + field_fetch('NAME') + end + + def names + name.split(', ') + end + + def definition + field_fetch('DEFINITION') + end + + def keggclass + field_fetch('CLASS') + end + + def keggclasses + keggclass.gsub(/ \[[^\]]+/, '').split(/\] ?/) + end + + def pathways + keggclass.scan(/\[PATH:(.*?)\]/).flatten + end + + def dblinks + unless @data['DBLINKS'] + hash = {} + get('DBLINKS').scan(/(\S+):\s*(.*)\n/).each do |k, v| + hash[k] = v.split(/\s+/) + end + @data['DBLINKS'] = hash + end + @data['DBLINKS'] # Hash of DB:ID in DBLINKS + end + + def genes + unless @data['GENES'] + hash = {} + k = '' + get('GENES').each_line do |line| + line.chomp! + line[0, @tagsize] = '' + if line =~ /(\S+):/ + k = $1 + hash[k] = [] + end + line[0, 5] = '' + line.gsub(/\(\S+/, '').each(' ') do |u| + hash[k] << u.strip + end + end + @data['GENES'] = hash + end + @data['GENES'] # Hash of DB:ID in DBLINKS + end + + end + + end + +end + + + +if __FILE__ == $0 + + require 'bio/io/fetch' + + flat = Bio::Fetch.query('ko', 'K00001') + entry = Bio::KEGG::KO.new(flat) + + p entry.entry_id + p entry.name + p entry.names + p entry.definition + p entry.keggclass + p entry.keggclasses + p entry.pathways + p entry.dblinks + p entry.genes + +end + + +=begin + += Bio::KEGG::KO + +KO (KEGG Orthology) entry parser. + +* (()) +* (()) + +--- Bio::KEGG::KO.new(entry) + +Reads a flat file format entry of the KO database. + +--- Bio::KEGG::KO#entry_id -> String + +Returns ID of the entry. + +--- Bio::KEGG::KO#name -> String + +Returns NAME field of the entry. + +--- Bio::KEGG::KO#names -> Array + +Returns an Array of names in NAME field. + +--- Bio::KEGG::KO#definition -> String + +Returns DEFINITION field of the entry. + +--- Bio::KEGG::KO#keggclass + +Returns CLASS field of the entry. + +--- Bio::KEGG::KO#keggclasses + +Returns an Array of biological classes in CLASS field. + +--- Bio::KEGG::KO#pathways + +Returns an Array of KEGG/PATHWAY ID in CLASS field. + +--- Bio::KEGG::KO#dblinks + +Returns a Hash of Array of the database name and entry IDs in DBLINKS field. + +--- Bio::KEGG::KO#genes + +Returns a Hash of Array of the organism ID and entry IDs in GENES field. + +=end + --- bioruby-1.1.0.orig/debian/changelog +++ bioruby-1.1.0/debian/changelog @@ -0,0 +1,90 @@ +bioruby (1.1.0-1) unstable; urgency=low + + * New upstream version + + Bioruby is now distributed under the same terms as ruby itself. + This gives you the option of using the GPL or a similar copyleft + license. See /usr/share/doc/libbio-ruby/copyright for details on the + alternate license. + + Lots of new and obsolete classes, see the upstream changelog for details + + BioRuby shell rewritten to utilize the rails generators + + Many bugfixes + * Re-work build system to utilize install.rb instead of my custom rules file + + Enable unit tests in the build + + Don't hardcode the binary names when hacking off the .rb suffix. Use + wildcards and a for loop to rename them + + Remove the libbio-ruby1.8.dirs file. The directories get installed by + the install.rb now + + The docs are built by install.rb now, so don't do custom stuff for them + in debian/rules + + Move building the manpages to the build-stamp target, rather than the + build target + + Add ruby to build-depends + + -- David Nusinow Sun, 22 Jul 2007 18:42:39 -0400 + +bioruby (1.0.0-1) unstable; urgency=low + + * New upstream version + * Add the bioruby shell program + * Add the Changes-0.7.html doc describing updates since 0.6.x + * Bump standards version to 3.7.2.0. No changes needed. + * Bump debhelper compat to 5 + * Move debhelper to build-depends from build-depends-indep + + -- David Nusinow Thu, 17 Aug 2006 00:28:21 +0000 + +bioruby (0.6.4-1) unstable; urgency=low + + * New upstream release + + siRNA designer class is contributed by Itoshi Nikaido. + (lib/bio/util/sirna.rb) + + fastacmd wrapper is contributed by Shinji Shigenobu. + (lib/bio/io/fastacmd.rb) + + bl2seq parser is contributed by Tomoaki Nishiyama. + (lib/bio/appl/bl2seq/report.rb) + + new application execution factory is provided. + (lib/bio/command.rb) + + FlatFile class can accept Blast results, Spidey, Blat, Sim4 and some + KEGG formats (KO, GLYCAN, REACTION) + + some methods are added to SPTr class proposed by Luca Pireddu. + (lib/bio/db/embl/sptr.rb) + + external2go parser is added. (lib/bio/db/go.rb) + + improved amino/nucleic data classes to have some handy methods. + (lib/bio/data/) + + fixed hmmer parser (by Masashi Fujita) and remote execution of blast and + fasta using GenomeNet. + + some English documentations are added. (doc/) + * Re-organize debian/rules handling of docs + + Ship new English tutorial and KEGG_API. These are turned to html with rd2 + + Put document building commands in the build target instead of configure + + Add commands to remove generated documents in the clean target + + Put package building commands in binary-indep where they belong + * Add build-dependency on rdtool to build html docs using rd2 + * Minor debian/copyright cleanup to get rid of stupid lintian warning about + boilerplate + * Change Build-Depends to Build-Depends-Indep + * Update standards version to 3.6.2. No changes needed. + * Add ruby1.8 to recommends for libbio-ruby1.8 + + -- David Nusinow Thu, 1 Sep 2005 14:04:35 -0400 + +bioruby (0.6.2-3) unstable; urgency=low + + * Add watch file + + -- David Nusinow Thu, 7 Apr 2005 22:12:44 -0400 + +bioruby (0.6.2-2) unstable; urgency=low + + * Depend on libruby1.8 instead of ruby1.8 to bring in line with ruby policy + * Add Recommends on blast2 for local blast + * Depend on docbook-to-man; closes: #302360 + + -- David Nusinow Tue, 1 Feb 2005 00:25:45 -0500 + +bioruby (0.6.2-1) unstable; urgency=low + + * Initial Release. + + -- David Nusinow Mon, 31 Jan 2005 11:11:55 -0500 + --- bioruby-1.1.0.orig/debian/docs +++ bioruby-1.1.0/debian/docs @@ -0,0 +1 @@ +README --- bioruby-1.1.0.orig/debian/br_biofetch.rb.sgml +++ bioruby-1.1.0/debian/br_biofetch.rb.sgml @@ -0,0 +1,182 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + + + The docbook-to-man binary is found in the docbook-to-man package. + Please remember that if you create the nroff version in one of the + debian/rules file targets (such as build), you will need to include + docbook-to-man in your Build-Depends control field. + + --> + + + David"> + Nusinow"> + + January 31, 2005"> + + 1"> + dnusinow@debian.org"> + + BIORUBY"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + biofetch client + + + + &dhpackage; + + server + db + id + + + + + + + DESCRIPTION + + This manual page documents briefly the + &dhpackage;. + + &dhpackage; is a very simple biofetch client. You + can connect to a biofetch server and retrieve database entries including + sequence information. + + + + OPTIONS + + + + + + + Specify the URL of the BioFetch CGI (default is http://bioruby.org/cgi-bin/biofetch.rb) + + + + + + + Use the EBI server at http://www.ebi.ac.uk/cgi-bin/dbfetch + + + + + + + Use the BioRuby server at http://bioruby.org/cgi-bin/biofetch.rb + + + + + + + Database name. This includes options like refseq, genbank, + embl, swissprot, etc. This option depends on which biofetch server + you are using. + + + + + + + entry id + + + + + + + \'raw\' or \'html\' (default is \'raw\') + + + + + + + Output format ('default, 'fasta', 'etc') + + + + + + SEE ALSO + + bar (1), baz (1). + + + + AUTHOR + + This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + + + + --- bioruby-1.1.0.orig/debian/br_bioflat.rb.sgml +++ bioruby-1.1.0/debian/br_bioflat.rb.sgml @@ -0,0 +1,256 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + + + The docbook-to-man binary is found in the docbook-to-man package. + Please remember that if you create the nroff version in one of the + debian/rules file targets (such as build), you will need to include + docbook-to-man in your Build-Depends control field. + + --> + + + David"> + Nusinow"> + + January 31, 2005"> + + 1"> + dnusinow@debian.org"> + + BIORUBY"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + OBDA flat file indexer + + + Search: + + &dhpackage; + + + + + &dhpackage; + + --location DIR + --dbname DBNAME + + KEYWORDS + + + Create index: + + &dhpackage; + + + + + + + + + Update index: + + &dhpackage; + + + + + + + + Show namespaces: + + &dhpackage; + + + + + + + &dhpackage; + + + + + &dhpackage; + + + + + + DESCRIPTION + + This manual page documents briefly the + &dhpackage;. + + &dhpackage; is an OBDA flat file indexer. + + + + OPTIONS + + + + + + + Search a database for keywords. + + + + + + + + Only valid with the --search option. Set the search namespace. + You can set this option multiple times to specify more than one + namespace. + + + + + + + Create an index. + + + + + + + Specify the directory. + + + + + + + Specify the name of the database. + + + + + + + + Set the primary and secondarynamespace of the index. Default + primary/secondary namespaces depend on the format of the flatfiles. + Only valid with the --create option. + + + + + + + Add secondary namespaces to the default specification. You can + use this option many times. Only valid with the --create option. + + + + + + + Update an index + + + + + + + Sort an index. You can set this to a path to an external + sorting program, or BUILTIN to use the builtin sort module. This + option is only valid with --create (or --update) and --type flat + options. + + + + + + + Re-read all flatfiles and update whole index. This option is + only valid with the --update option. + + + + + + + Display the namespaces for an index file. + + + + + + + AUTHOR + + This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + + + + --- bioruby-1.1.0.orig/debian/br_biogetseq.rb.sgml +++ bioruby-1.1.0/debian/br_biogetseq.rb.sgml @@ -0,0 +1,144 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + + + The docbook-to-man binary is found in the docbook-to-man package. + Please remember that if you create the nroff version in one of the + debian/rules file targets (such as build), you will need to include + docbook-to-man in your Build-Depends control field. + + --> + + + David"> + Nusinow"> + + January 31, 2005"> + + 1"> + dnusinow@debian.org"> + + BIORUBY"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + ODBA Sequence Retrieval + + + + &dhpackage; + + + + + + + + + DESCRIPTION + + This manual page documents briefly the + &dhpackage;. + + &dhpackage; is an ODBC sequence retrieval program. + Simply point it at the database of interest, with an optional namespace, + and give it the sequence id that you want, and it will retrieve it. + + + + OPTIONS + + + + + + + Specify the database to query (required). + + + + + + + Specify the namespace to query. + + + + + + + Specify the ID of the sequence to be retrieved. + + + + + + AUTHOR + + This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + + + + --- bioruby-1.1.0.orig/debian/br_pmfetch.rb.sgml +++ bioruby-1.1.0/debian/br_pmfetch.rb.sgml @@ -0,0 +1,288 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + + + The docbook-to-man binary is found in the docbook-to-man package. + Please remember that if you create the nroff version in one of the + debian/rules file targets (such as build), you will need to include + docbook-to-man in your Build-Depends control field. + + --> + + + David"> + Nusinow"> + + January 31, 2005"> + + 1"> + dnusinow@debian.org"> + + BIORUBY"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + PubMed Client + + + + &dhpackage; + + "query string" + + + &dhpackage; + + + + + + DESCRIPTION + + This manual page documents briefly the + &dhpackage;. + + &dhpackage; is a command line program to query + PubMed. It can take a variety of options (documented below) to restrict + your search query, which is specified by the query string. + + + + OPTIONS + + + + + + + + Query string for PubMed search. + + + + + + + + Title of the article to search. + + + + + + + + Journal title to search. + + + + + + + + Journal volume to search. + + + + + + + + Journal issue to search. + + + + + + + + First page number of the article to search. + + + + + + + + Author name to search. + + + + + + + + MeSH term to search. + + + + + + + + Summary output format. Options are endnote, medline, bibitem, + bibtex, report, abstract nature, science, genome_res, genome_biol, + nar, current, trends, cell. + + + + + + + + Output only a list of PudMed IDs. + + + + + + + + Number of articles to retrieve at the maximum. + + + + + + + + Starting number of articles to retrieve. + + + + + + + + Sort method for the summary output. Options are author, + journal, pub+date. + + + + + + + + Search articles published within recent # of days. + + + + + + + + Search articles published after the date YYYY/MM/DD. + + + + + + + + Search articles published before the date YYYY/MM/DD. + + + + + + + + Output help and then exit. + + + + + + + + Output example usages and then exit. + + + + + + + + Output version number and then exit. + + + + + + SEE ALSO + + The following pages have information on the PubMed search + options: http://www.ncbi.nlm.nih.gov/entrez/query/static/help/pmhelp.html + http://www.ncbi.nlm.nih.gov/entrez/query/static/esearch_help.html + + + + AUTHOR + + This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + + + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + + + + + + + + --- bioruby-1.1.0.orig/debian/rules +++ bioruby-1.1.0/debian/rules @@ -0,0 +1,84 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# Sample debian/rules that uses debhelper. +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + +RUBYVER = 1.8 +RUBYDIR = usr/lib/ruby +SITELIBDIR = $(RUBYDIR)/$(RUBYVER) +PREFIXDIR = $(CURDIR)/debian/libbio-ruby$(RUBYVER) + +configure: configure-stamp +configure-stamp: + dh_testdir + ruby install.rb config --prefix=$(PREFIXDIR)/usr --site-ruby-common=$(PREFIXDIR)/$(RUBYDIR) --site-ruby=$(PREFIXDIR)/$(SITELIBDIR) + ruby install.rb setup + ruby install.rb test + touch configure-stamp + +build: build-stamp + +build-stamp: configure-stamp + dh_testdir + # Build manpages + docbook-to-man debian/br_biofetch.rb.sgml > br_biofetch.1 + docbook-to-man debian/br_bioflat.rb.sgml > br_bioflat.1 + docbook-to-man debian/br_biogetseq.rb.sgml > br_biogetseq.1 + docbook-to-man debian/br_pmfetch.rb.sgml > br_pmfetch.1 + touch build-stamp + +clean: + dh_testdir + dh_testroot + rm -f build-stamp configure-stamp + dh_clean + ruby install.rb config --prefix=$(CURDIR)/debian/libbio-ruby$(RUBYVER)/usr + ruby install.rb clean + # Remove generated documents + rm -f br_biofetch.1 + rm -f br_bioflat.1 + rm -f br_biogetseq.1 + rm -f br_pmfetch.1 + +install: build + dh_testdir + dh_testroot + dh_clean -k + dh_installdirs + + ruby install.rb install + for FILE in `ls $(PREFIXDIR)/usr/bin/*rb`; do \ + BINNAME=$$(echo $$FILE | sed 's/\.rb$$//'); \ + mv $$FILE $$BINNAME; \ + done + + # Install docs + dh_installdocs doc etc/bioinformatics/seqdatabase.ini + dh_installexamples sample/* + +# Build architecture-independent files here. +binary-indep: build install + dh_testdir + dh_testroot + dh_installchangelogs ChangeLog + dh_installdocs + dh_installman br_biofetch.1 br_bioflat.1 br_biogetseq.1 br_pmfetch.1 + dh_compress + dh_fixperms + dh_installdeb + dh_shlibdeps + dh_gencontrol + dh_md5sums + dh_builddeb + +# Build architecture-dependent files here. +binary-arch: build install + +binary: binary-indep binary-arch +.PHONY: build clean binary-indep binary-arch binary install configure --- bioruby-1.1.0.orig/debian/compat +++ bioruby-1.1.0/debian/compat @@ -0,0 +1 @@ +5 --- bioruby-1.1.0.orig/debian/control +++ bioruby-1.1.0/debian/control @@ -0,0 +1,35 @@ +Source: bioruby +Section: science +Priority: optional +Maintainer: David Nusinow +Build-Depends: debhelper (>= 5.0.0), ruby +Build-Depends-Indep: docbook-to-man, rdtool +Standards-Version: 3.7.2.0 + +Package: libbio-ruby1.8 +Architecture: all +Depends: ${shlibs:Depends}, ${misc:Depends}, libruby1.8 +Recommends: blast2, ruby1.8 +Description: bioruby tools for computational molecular biology + BioRuby project aims to implement an integrated environment for + Bioinformatics with Ruby language. Design philosophy of the BioRuby library + is KISS (keep it simple and stupid) to maximize the usability and the + efficiency for biologists as a daily tool. The project was started in Japan + and supported by University of Tokyo (Human Genome Center), Kyoto University + (Bioinformatics Center) and the Open Bio Foundation. + . + http://www.bioruby.org + +Package: libbio-ruby +Architecture: all +Depends: ${shlibs:Depends}, ${misc:Depends}, libbio-ruby1.8 +Description: bioruby tools for computational molecular biology + BioRuby project aims to implement an integrated environment for + Bioinformatics with Ruby language. Design philosophy of the BioRuby library + is KISS (keep it simple and stupid) to maximize the usability and the + efficiency for biologists as a daily tool. The project was started in Japan + and supported by University of Tokyo (Human Genome Center), Kyoto University + (Bioinformatics Center) and the Open Bio Foundation. + . + This project is a dependency package, which depends on Debian's default Ruby + version (currently 1.8.x) --- bioruby-1.1.0.orig/debian/copyright +++ bioruby-1.1.0/debian/copyright @@ -0,0 +1,75 @@ +This package was debianized by David Nusinow on +Mon, 31 Jan 2005 11:11:55 -0500. + +It was downloaded from http://www.bioruby.org + +Copyright: KATAYAMA Toshiaki + +Upstream Authors: * KATAYAMA Toshiaki , project leader + * Yoshinori K. Okuji + * Mitsuteru C. Nakao + * KAWASHIMA Shuichi + * GOTO Naohisa + +License: + +This library is distributed under the same terms as ruby. As such, it may +be distributed either under the terms of the GPL or the conditions below: + + 1. You may make and give away verbatim copies of the source form of the + software without restriction, provided that you duplicate all of the + original copyright notices and associated disclaimers. + + 2. You may modify your copy of the software in any way, provided that + you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise + make them Freely Available, such as by posting said + modifications to Usenet or an equivalent medium, or by allowing + the author to include your modifications in the software. + + b) use the modified software only within your corporation or + organization. + + c) rename any non-standard executables so the names do not conflict + with standard executables, which must also be provided. + + d) make other distribution arrangements with the author. + + 3. You may distribute the software in object code or executable + form, provided that you do at least ONE of the following: + + a) distribute the executables and library files of the software, + together with instructions (in the manual page or equivalent) + on where to get the original distribution. + + b) accompany the distribution with the machine-readable source of + the software. + + c) give non-standard executables non-standard names, with + instructions on where to get the original software distribution. + + d) make other distribution arrangements with the author. + + 4. You may modify and include the part of the software into any other + software (possibly commercial). But some files in the distribution + are not written by the author, so that they are not under this terms. + They are gc.c(partly), utils.c(partly), regex.[ch], fnmatch.[ch], + glob.c, st.[ch] and some files under the ./missing directory. See + each file for the copying condition. + + 5. The scripts and library files supplied as input to or produced as + output from the software do not automatically fall under the + copyright of the software, but belong to whomever generated them, + and may be sold commercially, and may be aggregated with this + software. + + 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR + IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR + PURPOSE. + +-- +On Debian GNU/Linux systems, the complete text of the GNU General +Public License can be found in `/usr/share/common-licenses/GPL'. + --- bioruby-1.1.0.orig/debian/watch +++ bioruby-1.1.0/debian/watch @@ -0,0 +1,3 @@ +version=3 + +http://bioruby.org/archive/bioruby-(.*)\.tar\.gz