ngoto-bio 1.2.9.9001
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +2046 -0
- data/README.rdoc +223 -0
- data/README_DEV.rdoc +285 -0
- data/Rakefile +70 -0
- data/bin/bioruby +44 -0
- data/bin/br_biofetch.rb +47 -0
- data/bin/br_bioflat.rb +293 -0
- data/bin/br_biogetseq.rb +45 -0
- data/bin/br_pmfetch.rb +421 -0
- data/bioruby.gemspec +463 -0
- data/bioruby.gemspec.erb +79 -0
- data/doc/Changes-0.7.rd +369 -0
- data/doc/Changes-1.3.rdoc +195 -0
- data/doc/KEGG_API.rd +1843 -0
- data/doc/KEGG_API.rd.ja +1834 -0
- data/doc/Tutorial.rd +1296 -0
- data/doc/Tutorial.rd.ja +2640 -0
- data/etc/bioinformatics/seqdatabase.ini +210 -0
- data/extconf.rb +2 -0
- data/lib/bio/alignment.rb +2518 -0
- data/lib/bio/appl/bl2seq/report.rb +334 -0
- data/lib/bio/appl/blast/ddbj.rb +142 -0
- data/lib/bio/appl/blast/format0.rb +1438 -0
- data/lib/bio/appl/blast/format8.rb +83 -0
- data/lib/bio/appl/blast/genomenet.rb +263 -0
- data/lib/bio/appl/blast/ncbioptions.rb +220 -0
- data/lib/bio/appl/blast/remote.rb +105 -0
- data/lib/bio/appl/blast/report.rb +767 -0
- data/lib/bio/appl/blast/rexml.rb +144 -0
- data/lib/bio/appl/blast/rpsblast.rb +277 -0
- data/lib/bio/appl/blast/wublast.rb +671 -0
- data/lib/bio/appl/blast/xmlparser.rb +236 -0
- data/lib/bio/appl/blast.rb +505 -0
- data/lib/bio/appl/blat/report.rb +530 -0
- data/lib/bio/appl/clustalw/report.rb +152 -0
- data/lib/bio/appl/clustalw.rb +219 -0
- data/lib/bio/appl/emboss.rb +203 -0
- data/lib/bio/appl/fasta/format10.rb +325 -0
- data/lib/bio/appl/fasta.rb +235 -0
- data/lib/bio/appl/gcg/msf.rb +212 -0
- data/lib/bio/appl/gcg/seq.rb +195 -0
- data/lib/bio/appl/genscan/report.rb +552 -0
- data/lib/bio/appl/hmmer/report.rb +683 -0
- data/lib/bio/appl/hmmer.rb +126 -0
- data/lib/bio/appl/iprscan/report.rb +374 -0
- data/lib/bio/appl/mafft/report.rb +226 -0
- data/lib/bio/appl/mafft.rb +259 -0
- data/lib/bio/appl/muscle.rb +52 -0
- data/lib/bio/appl/paml/baseml/report.rb +32 -0
- data/lib/bio/appl/paml/baseml.rb +95 -0
- data/lib/bio/appl/paml/codeml/rates.rb +67 -0
- data/lib/bio/appl/paml/codeml/report.rb +67 -0
- data/lib/bio/appl/paml/codeml.rb +242 -0
- data/lib/bio/appl/paml/common.rb +348 -0
- data/lib/bio/appl/paml/common_report.rb +38 -0
- data/lib/bio/appl/paml/yn00/report.rb +32 -0
- data/lib/bio/appl/paml/yn00.rb +103 -0
- data/lib/bio/appl/phylip/alignment.rb +129 -0
- data/lib/bio/appl/phylip/distance_matrix.rb +96 -0
- data/lib/bio/appl/probcons.rb +41 -0
- data/lib/bio/appl/psort/report.rb +457 -0
- data/lib/bio/appl/psort.rb +548 -0
- data/lib/bio/appl/pts1.rb +263 -0
- data/lib/bio/appl/sim4/report.rb +485 -0
- data/lib/bio/appl/sim4.rb +124 -0
- data/lib/bio/appl/sosui/report.rb +151 -0
- data/lib/bio/appl/spidey/report.rb +593 -0
- data/lib/bio/appl/targetp/report.rb +267 -0
- data/lib/bio/appl/tcoffee.rb +55 -0
- data/lib/bio/appl/tmhmm/report.rb +231 -0
- data/lib/bio/command.rb +593 -0
- data/lib/bio/compat/features.rb +157 -0
- data/lib/bio/compat/references.rb +128 -0
- data/lib/bio/data/aa.rb +349 -0
- data/lib/bio/data/codontable.rb +722 -0
- data/lib/bio/data/na.rb +223 -0
- data/lib/bio/db/aaindex.rb +357 -0
- data/lib/bio/db/biosql/biosql_to_biosequence.rb +67 -0
- data/lib/bio/db/biosql/sequence.rb +508 -0
- data/lib/bio/db/embl/common.rb +352 -0
- data/lib/bio/db/embl/embl.rb +500 -0
- data/lib/bio/db/embl/embl_to_biosequence.rb +85 -0
- data/lib/bio/db/embl/format_embl.rb +190 -0
- data/lib/bio/db/embl/sptr.rb +1283 -0
- data/lib/bio/db/embl/swissprot.rb +42 -0
- data/lib/bio/db/embl/trembl.rb +41 -0
- data/lib/bio/db/embl/uniprot.rb +42 -0
- data/lib/bio/db/fantom.rb +597 -0
- data/lib/bio/db/fasta/defline.rb +532 -0
- data/lib/bio/db/fasta/fasta_to_biosequence.rb +63 -0
- data/lib/bio/db/fasta/format_fasta.rb +97 -0
- data/lib/bio/db/fasta.rb +410 -0
- data/lib/bio/db/genbank/common.rb +307 -0
- data/lib/bio/db/genbank/ddbj.rb +22 -0
- data/lib/bio/db/genbank/format_genbank.rb +187 -0
- data/lib/bio/db/genbank/genbank.rb +250 -0
- data/lib/bio/db/genbank/genbank_to_biosequence.rb +86 -0
- data/lib/bio/db/genbank/genpept.rb +60 -0
- data/lib/bio/db/genbank/refseq.rb +18 -0
- data/lib/bio/db/gff.rb +1846 -0
- data/lib/bio/db/go.rb +481 -0
- data/lib/bio/db/kegg/brite.rb +41 -0
- data/lib/bio/db/kegg/compound.rb +131 -0
- data/lib/bio/db/kegg/drug.rb +98 -0
- data/lib/bio/db/kegg/enzyme.rb +148 -0
- data/lib/bio/db/kegg/expression.rb +155 -0
- data/lib/bio/db/kegg/genes.rb +263 -0
- data/lib/bio/db/kegg/genome.rb +241 -0
- data/lib/bio/db/kegg/glycan.rb +166 -0
- data/lib/bio/db/kegg/keggtab.rb +357 -0
- data/lib/bio/db/kegg/kgml.rb +256 -0
- data/lib/bio/db/kegg/orthology.rb +136 -0
- data/lib/bio/db/kegg/reaction.rb +82 -0
- data/lib/bio/db/kegg/taxonomy.rb +331 -0
- data/lib/bio/db/lasergene.rb +209 -0
- data/lib/bio/db/litdb.rb +107 -0
- data/lib/bio/db/medline.rb +326 -0
- data/lib/bio/db/nbrf.rb +191 -0
- data/lib/bio/db/newick.rb +658 -0
- data/lib/bio/db/nexus.rb +1854 -0
- data/lib/bio/db/pdb/atom.rb +77 -0
- data/lib/bio/db/pdb/chain.rb +210 -0
- data/lib/bio/db/pdb/chemicalcomponent.rb +224 -0
- data/lib/bio/db/pdb/model.rb +148 -0
- data/lib/bio/db/pdb/pdb.rb +1911 -0
- data/lib/bio/db/pdb/residue.rb +176 -0
- data/lib/bio/db/pdb/utils.rb +399 -0
- data/lib/bio/db/pdb.rb +29 -0
- data/lib/bio/db/prosite.rb +597 -0
- data/lib/bio/db/rebase.rb +456 -0
- data/lib/bio/db/soft.rb +404 -0
- data/lib/bio/db/transfac.rb +375 -0
- data/lib/bio/db.rb +329 -0
- data/lib/bio/feature.rb +139 -0
- data/lib/bio/io/biosql/biodatabase.rb +64 -0
- data/lib/bio/io/biosql/bioentry.rb +29 -0
- data/lib/bio/io/biosql/bioentry_dbxref.rb +11 -0
- data/lib/bio/io/biosql/bioentry_path.rb +12 -0
- data/lib/bio/io/biosql/bioentry_qualifier_value.rb +10 -0
- data/lib/bio/io/biosql/bioentry_reference.rb +10 -0
- data/lib/bio/io/biosql/bioentry_relationship.rb +10 -0
- data/lib/bio/io/biosql/biosequence.rb +11 -0
- data/lib/bio/io/biosql/comment.rb +7 -0
- data/lib/bio/io/biosql/config/database.yml +20 -0
- data/lib/bio/io/biosql/dbxref.rb +13 -0
- data/lib/bio/io/biosql/dbxref_qualifier_value.rb +12 -0
- data/lib/bio/io/biosql/location.rb +32 -0
- data/lib/bio/io/biosql/location_qualifier_value.rb +11 -0
- data/lib/bio/io/biosql/ontology.rb +10 -0
- data/lib/bio/io/biosql/reference.rb +9 -0
- data/lib/bio/io/biosql/seqfeature.rb +32 -0
- data/lib/bio/io/biosql/seqfeature_dbxref.rb +11 -0
- data/lib/bio/io/biosql/seqfeature_path.rb +11 -0
- data/lib/bio/io/biosql/seqfeature_qualifier_value.rb +20 -0
- data/lib/bio/io/biosql/seqfeature_relationship.rb +11 -0
- data/lib/bio/io/biosql/taxon.rb +12 -0
- data/lib/bio/io/biosql/taxon_name.rb +9 -0
- data/lib/bio/io/biosql/term.rb +27 -0
- data/lib/bio/io/biosql/term_dbxref.rb +11 -0
- data/lib/bio/io/biosql/term_path.rb +12 -0
- data/lib/bio/io/biosql/term_relationship.rb +13 -0
- data/lib/bio/io/biosql/term_relationship_term.rb +11 -0
- data/lib/bio/io/biosql/term_synonym.rb +10 -0
- data/lib/bio/io/das.rb +461 -0
- data/lib/bio/io/dbget.rb +194 -0
- data/lib/bio/io/ddbjxml.rb +638 -0
- data/lib/bio/io/ebisoap.rb +158 -0
- data/lib/bio/io/ensembl.rb +229 -0
- data/lib/bio/io/fastacmd.rb +163 -0
- data/lib/bio/io/fetch.rb +195 -0
- data/lib/bio/io/flatfile/autodetection.rb +545 -0
- data/lib/bio/io/flatfile/bdb.rb +253 -0
- data/lib/bio/io/flatfile/buffer.rb +237 -0
- data/lib/bio/io/flatfile/index.rb +1381 -0
- data/lib/bio/io/flatfile/indexer.rb +805 -0
- data/lib/bio/io/flatfile/splitter.rb +297 -0
- data/lib/bio/io/flatfile.rb +473 -0
- data/lib/bio/io/higet.rb +73 -0
- data/lib/bio/io/hinv.rb +442 -0
- data/lib/bio/io/keggapi.rb +805 -0
- data/lib/bio/io/ncbirest.rb +733 -0
- data/lib/bio/io/ncbisoap.rb +155 -0
- data/lib/bio/io/pubmed.rb +307 -0
- data/lib/bio/io/registry.rb +292 -0
- data/lib/bio/io/soapwsdl.rb +119 -0
- data/lib/bio/io/sql.rb +186 -0
- data/lib/bio/location.rb +867 -0
- data/lib/bio/map.rb +410 -0
- data/lib/bio/pathway.rb +960 -0
- data/lib/bio/reference.rb +602 -0
- data/lib/bio/sequence/aa.rb +125 -0
- data/lib/bio/sequence/adapter.rb +108 -0
- data/lib/bio/sequence/common.rb +310 -0
- data/lib/bio/sequence/compat.rb +123 -0
- data/lib/bio/sequence/dblink.rb +54 -0
- data/lib/bio/sequence/format.rb +358 -0
- data/lib/bio/sequence/format_raw.rb +23 -0
- data/lib/bio/sequence/generic.rb +24 -0
- data/lib/bio/sequence/na.rb +491 -0
- data/lib/bio/sequence.rb +456 -0
- data/lib/bio/shell/core.rb +578 -0
- data/lib/bio/shell/demo.rb +146 -0
- data/lib/bio/shell/interface.rb +218 -0
- data/lib/bio/shell/irb.rb +95 -0
- data/lib/bio/shell/object.rb +71 -0
- data/lib/bio/shell/plugin/blast.rb +42 -0
- data/lib/bio/shell/plugin/codon.rb +218 -0
- data/lib/bio/shell/plugin/das.rb +58 -0
- data/lib/bio/shell/plugin/emboss.rb +23 -0
- data/lib/bio/shell/plugin/entry.rb +105 -0
- data/lib/bio/shell/plugin/flatfile.rb +101 -0
- data/lib/bio/shell/plugin/keggapi.rb +181 -0
- data/lib/bio/shell/plugin/midi.rb +430 -0
- data/lib/bio/shell/plugin/obda.rb +45 -0
- data/lib/bio/shell/plugin/psort.rb +56 -0
- data/lib/bio/shell/plugin/seq.rb +247 -0
- data/lib/bio/shell/plugin/soap.rb +87 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/bioruby_generator.rb +29 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/_classes.rhtml +4 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/_log.rhtml +27 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/_methods.rhtml +11 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/_modules.rhtml +4 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/_variables.rhtml +7 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby-bg.gif +0 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby-gem.png +0 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby-link.gif +0 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby.css +368 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby.rhtml +47 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby_controller.rb +144 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby_helper.rb +47 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/commands.rhtml +8 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/history.rhtml +10 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/index.rhtml +26 -0
- data/lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/spinner.gif +0 -0
- data/lib/bio/shell/script.rb +25 -0
- data/lib/bio/shell/setup.rb +109 -0
- data/lib/bio/shell/web.rb +102 -0
- data/lib/bio/shell.rb +44 -0
- data/lib/bio/tree.rb +852 -0
- data/lib/bio/util/color_scheme/buried.rb +59 -0
- data/lib/bio/util/color_scheme/helix.rb +59 -0
- data/lib/bio/util/color_scheme/hydropathy.rb +64 -0
- data/lib/bio/util/color_scheme/nucleotide.rb +31 -0
- data/lib/bio/util/color_scheme/strand.rb +59 -0
- data/lib/bio/util/color_scheme/taylor.rb +50 -0
- data/lib/bio/util/color_scheme/turn.rb +59 -0
- data/lib/bio/util/color_scheme/zappo.rb +50 -0
- data/lib/bio/util/color_scheme.rb +191 -0
- data/lib/bio/util/contingency_table.rb +370 -0
- data/lib/bio/util/restriction_enzyme/analysis.rb +249 -0
- data/lib/bio/util/restriction_enzyme/analysis_basic.rb +217 -0
- data/lib/bio/util/restriction_enzyme/cut_symbol.rb +107 -0
- data/lib/bio/util/restriction_enzyme/double_stranded/aligned_strands.rb +130 -0
- data/lib/bio/util/restriction_enzyme/double_stranded/cut_location_pair.rb +103 -0
- data/lib/bio/util/restriction_enzyme/double_stranded/cut_location_pair_in_enzyme_notation.rb +38 -0
- data/lib/bio/util/restriction_enzyme/double_stranded/cut_locations.rb +76 -0
- data/lib/bio/util/restriction_enzyme/double_stranded/cut_locations_in_enzyme_notation.rb +107 -0
- data/lib/bio/util/restriction_enzyme/double_stranded.rb +321 -0
- data/lib/bio/util/restriction_enzyme/enzymes.yaml +7061 -0
- data/lib/bio/util/restriction_enzyme/range/cut_range.rb +24 -0
- data/lib/bio/util/restriction_enzyme/range/cut_ranges.rb +47 -0
- data/lib/bio/util/restriction_enzyme/range/horizontal_cut_range.rb +67 -0
- data/lib/bio/util/restriction_enzyme/range/sequence_range/calculated_cuts.rb +242 -0
- data/lib/bio/util/restriction_enzyme/range/sequence_range/fragment.rb +51 -0
- data/lib/bio/util/restriction_enzyme/range/sequence_range/fragments.rb +41 -0
- data/lib/bio/util/restriction_enzyme/range/sequence_range.rb +257 -0
- data/lib/bio/util/restriction_enzyme/range/vertical_cut_range.rb +77 -0
- data/lib/bio/util/restriction_enzyme/single_strand/cut_locations_in_enzyme_notation.rb +135 -0
- data/lib/bio/util/restriction_enzyme/single_strand.rb +200 -0
- data/lib/bio/util/restriction_enzyme/single_strand_complement.rb +23 -0
- data/lib/bio/util/restriction_enzyme/string_formatting.rb +111 -0
- data/lib/bio/util/restriction_enzyme.rb +228 -0
- data/lib/bio/util/sirna.rb +288 -0
- data/lib/bio.rb +300 -0
- data/rdoc.zsh +8 -0
- data/sample/any2fasta.rb +59 -0
- data/sample/biofetch.rb +475 -0
- data/sample/color_scheme_na.rb +91 -0
- data/sample/dbget +37 -0
- data/sample/demo_sequence.rb +158 -0
- data/sample/enzymes.rb +78 -0
- data/sample/fasta2tab.rb +99 -0
- data/sample/fastagrep.rb +72 -0
- data/sample/fastasort.rb +54 -0
- data/sample/fsplit.rb +51 -0
- data/sample/gb2fasta.rb +30 -0
- data/sample/gb2tab.rb +325 -0
- data/sample/gbtab2mysql.rb +161 -0
- data/sample/genes2nuc.rb +33 -0
- data/sample/genes2pep.rb +33 -0
- data/sample/genes2tab.rb +81 -0
- data/sample/genome2rb.rb +29 -0
- data/sample/genome2tab.rb +76 -0
- data/sample/goslim.rb +303 -0
- data/sample/gt2fasta.rb +47 -0
- data/sample/na2aa.rb +34 -0
- data/sample/pmfetch.rb +42 -0
- data/sample/pmsearch.rb +42 -0
- data/sample/psortplot_html.rb +214 -0
- data/sample/ssearch2tab.rb +96 -0
- data/sample/tdiary.rb +158 -0
- data/sample/tfastx2tab.rb +100 -0
- data/sample/vs-genes.rb +212 -0
- data/setup.rb +1596 -0
- data/test/data/HMMER/hmmpfam.out +64 -0
- data/test/data/HMMER/hmmsearch.out +88 -0
- data/test/data/SOSUI/sample.report +11 -0
- data/test/data/TMHMM/sample.report +21 -0
- data/test/data/aaindex/DAYM780301 +30 -0
- data/test/data/aaindex/PRAM900102 +20 -0
- data/test/data/bl2seq/cd8a_cd8b_blastp.bl2seq +53 -0
- data/test/data/bl2seq/cd8a_p53_e-5blastp.bl2seq +37 -0
- data/test/data/blast/2.2.15.blastp.m7 +876 -0
- data/test/data/blast/b0002.faa +15 -0
- data/test/data/blast/b0002.faa.m0 +128 -0
- data/test/data/blast/b0002.faa.m7 +65 -0
- data/test/data/blast/b0002.faa.m8 +1 -0
- data/test/data/blast/blastp-multi.m7 +188 -0
- data/test/data/command/echoarg2.bat +1 -0
- data/test/data/embl/AB090716.embl +65 -0
- data/test/data/embl/AB090716.embl.rel89 +63 -0
- data/test/data/fasta/example1.txt +75 -0
- data/test/data/fasta/example2.txt +21 -0
- data/test/data/genscan/sample.report +63 -0
- data/test/data/iprscan/merged.raw +32 -0
- data/test/data/iprscan/merged.txt +74 -0
- data/test/data/paml/codeml/control_file.txt +30 -0
- data/test/data/paml/codeml/output.txt +78 -0
- data/test/data/paml/codeml/rates +217 -0
- data/test/data/prosite/prosite.dat +2233 -0
- data/test/data/refseq/nm_126355.entret +64 -0
- data/test/data/rpsblast/misc.rpsblast +193 -0
- data/test/data/soft/GDS100_partial.soft +92 -0
- data/test/data/soft/GSE3457_family_partial.soft +874 -0
- data/test/data/uniprot/p53_human.uniprot +1456 -0
- data/test/functional/bio/appl/test_pts1.rb +115 -0
- data/test/functional/bio/io/test_ensembl.rb +229 -0
- data/test/functional/bio/io/test_soapwsdl.rb +52 -0
- data/test/functional/bio/sequence/test_output_embl.rb +51 -0
- data/test/functional/bio/test_command.rb +301 -0
- data/test/runner.rb +23 -0
- data/test/unit/bio/appl/bl2seq/test_report.rb +134 -0
- data/test/unit/bio/appl/blast/test_ncbioptions.rb +112 -0
- data/test/unit/bio/appl/blast/test_report.rb +1135 -0
- data/test/unit/bio/appl/blast/test_rpsblast.rb +398 -0
- data/test/unit/bio/appl/genscan/test_report.rb +182 -0
- data/test/unit/bio/appl/hmmer/test_report.rb +342 -0
- data/test/unit/bio/appl/iprscan/test_report.rb +338 -0
- data/test/unit/bio/appl/mafft/test_report.rb +63 -0
- data/test/unit/bio/appl/paml/codeml/test_rates.rb +45 -0
- data/test/unit/bio/appl/paml/codeml/test_report.rb +45 -0
- data/test/unit/bio/appl/paml/test_codeml.rb +174 -0
- data/test/unit/bio/appl/sosui/test_report.rb +81 -0
- data/test/unit/bio/appl/targetp/test_report.rb +146 -0
- data/test/unit/bio/appl/test_blast.rb +277 -0
- data/test/unit/bio/appl/test_fasta.rb +130 -0
- data/test/unit/bio/appl/test_pts1.rb +77 -0
- data/test/unit/bio/appl/tmhmm/test_report.rb +126 -0
- data/test/unit/bio/data/test_aa.rb +90 -0
- data/test/unit/bio/data/test_codontable.rb +107 -0
- data/test/unit/bio/data/test_na.rb +80 -0
- data/test/unit/bio/db/embl/test_common.rb +117 -0
- data/test/unit/bio/db/embl/test_embl.rb +214 -0
- data/test/unit/bio/db/embl/test_embl_rel89.rb +219 -0
- data/test/unit/bio/db/embl/test_embl_to_bioseq.rb +203 -0
- data/test/unit/bio/db/embl/test_sptr.rb +1812 -0
- data/test/unit/bio/db/embl/test_uniprot.rb +31 -0
- data/test/unit/bio/db/kegg/test_genes.rb +45 -0
- data/test/unit/bio/db/pdb/test_pdb.rb +152 -0
- data/test/unit/bio/db/test_aaindex.rb +197 -0
- data/test/unit/bio/db/test_fasta.rb +250 -0
- data/test/unit/bio/db/test_gff.rb +1190 -0
- data/test/unit/bio/db/test_lasergene.rb +95 -0
- data/test/unit/bio/db/test_medline.rb +127 -0
- data/test/unit/bio/db/test_newick.rb +293 -0
- data/test/unit/bio/db/test_nexus.rb +364 -0
- data/test/unit/bio/db/test_prosite.rb +1437 -0
- data/test/unit/bio/db/test_rebase.rb +101 -0
- data/test/unit/bio/db/test_soft.rb +138 -0
- data/test/unit/bio/io/flatfile/test_autodetection.rb +375 -0
- data/test/unit/bio/io/flatfile/test_buffer.rb +251 -0
- data/test/unit/bio/io/flatfile/test_splitter.rb +369 -0
- data/test/unit/bio/io/test_ddbjxml.rb +80 -0
- data/test/unit/bio/io/test_ensembl.rb +109 -0
- data/test/unit/bio/io/test_fastacmd.rb +42 -0
- data/test/unit/bio/io/test_flatfile.rb +488 -0
- data/test/unit/bio/io/test_soapwsdl.rb +32 -0
- data/test/unit/bio/sequence/test_aa.rb +103 -0
- data/test/unit/bio/sequence/test_common.rb +373 -0
- data/test/unit/bio/sequence/test_compat.rb +69 -0
- data/test/unit/bio/sequence/test_dblink.rb +58 -0
- data/test/unit/bio/sequence/test_na.rb +330 -0
- data/test/unit/bio/shell/plugin/test_seq.rb +185 -0
- data/test/unit/bio/test_alignment.rb +1025 -0
- data/test/unit/bio/test_command.rb +349 -0
- data/test/unit/bio/test_db.rb +96 -0
- data/test/unit/bio/test_feature.rb +144 -0
- data/test/unit/bio/test_location.rb +599 -0
- data/test/unit/bio/test_map.rb +230 -0
- data/test/unit/bio/test_pathway.rb +499 -0
- data/test/unit/bio/test_reference.rb +252 -0
- data/test/unit/bio/test_sequence.rb +329 -0
- data/test/unit/bio/test_shell.rb +18 -0
- data/test/unit/bio/test_tree.rb +593 -0
- data/test/unit/bio/util/restriction_enzyme/analysis/test_calculated_cuts.rb +299 -0
- data/test/unit/bio/util/restriction_enzyme/analysis/test_cut_ranges.rb +103 -0
- data/test/unit/bio/util/restriction_enzyme/analysis/test_sequence_range.rb +240 -0
- data/test/unit/bio/util/restriction_enzyme/double_stranded/test_aligned_strands.rb +101 -0
- data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_location_pair.rb +75 -0
- data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_location_pair_in_enzyme_notation.rb +73 -0
- data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_locations.rb +53 -0
- data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_locations_in_enzyme_notation.rb +104 -0
- data/test/unit/bio/util/restriction_enzyme/single_strand/test_cut_locations_in_enzyme_notation.rb +83 -0
- data/test/unit/bio/util/restriction_enzyme/test_analysis.rb +246 -0
- data/test/unit/bio/util/restriction_enzyme/test_cut_symbol.rb +44 -0
- data/test/unit/bio/util/restriction_enzyme/test_double_stranded.rb +115 -0
- data/test/unit/bio/util/restriction_enzyme/test_single_strand.rb +147 -0
- data/test/unit/bio/util/restriction_enzyme/test_single_strand_complement.rb +147 -0
- data/test/unit/bio/util/restriction_enzyme/test_string_formatting.rb +60 -0
- data/test/unit/bio/util/test_color_scheme.rb +33 -0
- data/test/unit/bio/util/test_contingency_table.rb +94 -0
- data/test/unit/bio/util/test_restriction_enzyme.rb +42 -0
- data/test/unit/bio/util/test_sirna.rb +245 -0
- metadata +484 -0
data/README.rdoc
ADDED
@@ -0,0 +1,223 @@
|
|
1
|
+
--
|
2
|
+
= README.rdoc - README for BioRuby
|
3
|
+
Copyright:: Copyright (C) 2001-2007 Toshiaki Katayama <k@bioruby.org>,
|
4
|
+
Copyright (C) 2008 Jan Aerts <jandot@bioruby.org>
|
5
|
+
License:: The Ruby License
|
6
|
+
* The above statement is limited to this file. See below about BioRuby's
|
7
|
+
copyright and license.
|
8
|
+
++
|
9
|
+
|
10
|
+
= BioRuby
|
11
|
+
|
12
|
+
Copyright (C) 2001-2009 Toshiaki Katayama <k@bioruby.org>
|
13
|
+
|
14
|
+
BioRuby is an open source Ruby library for developing bioinformatics
|
15
|
+
software. Object oriented scripting language Ruby has many features
|
16
|
+
suitable for bioinformatics research, for example, clear syntax to
|
17
|
+
express complex objects, regular expressions for text handling as
|
18
|
+
powerful as Perl's, a wide variety of libraries including web service
|
19
|
+
etc. As the syntax of the Ruby language is simple and very clean, we
|
20
|
+
believe that it is easy to learn for beginners, easy to use for
|
21
|
+
biologists, and also powerful enough for the software developers.
|
22
|
+
|
23
|
+
In BioRuby, you can retrieve biological database entries from flat
|
24
|
+
files, internet web servers and local relational databases. These
|
25
|
+
database entries can be parsed to extract information you need.
|
26
|
+
Biological sequences can be treated with the fulfilling methods of the
|
27
|
+
Ruby's String class and with regular expressions. Daily tools like
|
28
|
+
Blast, Fasta, Hmmer and many other software packages for biological
|
29
|
+
analysis can be executed within the BioRuby script, and the results
|
30
|
+
can be fully parsed to extract the portion you need. BioRuby supports
|
31
|
+
major biological database formats and provides many ways for accessing
|
32
|
+
them through flatfile indexing, SQL, web services etc. Various web
|
33
|
+
services including KEGG API can be easily utilized by BioRuby.
|
34
|
+
|
35
|
+
|
36
|
+
== FOR MORE INFORMATION
|
37
|
+
|
38
|
+
BioRuby's official website is at http://bioruby.org/.
|
39
|
+
You will find links to related resources including downloads,
|
40
|
+
mailing lists, Wiki documentation etc. in the top page.
|
41
|
+
|
42
|
+
* http://bioruby.org/
|
43
|
+
|
44
|
+
|
45
|
+
== WHERE TO OBTAIN
|
46
|
+
|
47
|
+
=== WWW
|
48
|
+
|
49
|
+
The stable release is freely available from the BioRuby website.
|
50
|
+
|
51
|
+
* http://bioruby.org/archive/
|
52
|
+
|
53
|
+
=== RubyGems
|
54
|
+
|
55
|
+
RubyGems[URL:http://rubyforge.org/projects/rubygems/] version of
|
56
|
+
the BioRuby package is also available for easy installation.
|
57
|
+
|
58
|
+
* http://rubyforge.org/projects/bioruby/
|
59
|
+
|
60
|
+
=== git
|
61
|
+
|
62
|
+
If you need the latest development version, this is provided at
|
63
|
+
|
64
|
+
* http://github.com/bioruby/bioruby
|
65
|
+
|
66
|
+
and can be obtained by the following procedure:
|
67
|
+
|
68
|
+
% git clone git://github.com/bioruby/bioruby.git
|
69
|
+
|
70
|
+
==== CVS
|
71
|
+
|
72
|
+
CVS is now deprecated as source control has moved to github. Please use git
|
73
|
+
instead of CVS. For historical purposes: the anonymous CVS was provided at
|
74
|
+
|
75
|
+
* http://cvs.bioruby.org/
|
76
|
+
|
77
|
+
and could be obtained by the following procedure.
|
78
|
+
|
79
|
+
% cvs -d :pserver:cvs@code.open-bio.org:/home/repository/bioruby login
|
80
|
+
CVS password: cvs (login with a password 'cvs' for the first time)
|
81
|
+
% cvs -d :pserver:cvs@code.open-bio.org:/home/repository/bioruby co bioruby
|
82
|
+
|
83
|
+
|
84
|
+
== REQUIREMENTS
|
85
|
+
|
86
|
+
* Ruby 1.8.2 or later -- http://www.ruby-lang.org/
|
87
|
+
* Ruby 1.8.5 or later is recommended.
|
88
|
+
* Not yet fully ready with Ruby 1.9, although many components can now work
|
89
|
+
in Ruby 1.9.1.
|
90
|
+
|
91
|
+
== OPTIONAL REQUIREMENTS
|
92
|
+
|
93
|
+
Some optional libraries can be utilized to extend BioRuby's functionality.
|
94
|
+
If your needs meets the following conditions, install them from the "Ruby
|
95
|
+
Application Archive" at http://raa.ruby-lang.org/, RubyForge at
|
96
|
+
http://rubyforge.org/, or the following web sites.
|
97
|
+
|
98
|
+
For faster parsing of the BLAST XML output format:
|
99
|
+
|
100
|
+
* {RAA:xmlparser}[http://raa.ruby-lang.org/project/xmlparser/]
|
101
|
+
|
102
|
+
Creating faster flatfile index using Berkley DB:
|
103
|
+
|
104
|
+
* {RAA:bdb}[http://raa.ruby-lang.org/project/bdb/]
|
105
|
+
|
106
|
+
Accessing BioSQL database created by other Open Bio* libraries:
|
107
|
+
|
108
|
+
* {RubyForge:ActiveRecord}[http://rubyforge.org/projects/activerecord/]
|
109
|
+
and at least one driver (or adapter) from
|
110
|
+
{RubyForge:MySQL/Ruby}[http://rubyforge.org/projects/mysql-ruby/],
|
111
|
+
{RubyForge:postgres-pr}[http://rubyforge.org/projects/postgres-pr], or
|
112
|
+
{RubyForge:ActiveRecord Oracle enhanced adapter}[http://rubyforge.org/projects/oracle-enhanced/].
|
113
|
+
* For BioRuby 1.2.1 or older version,
|
114
|
+
{RubyForge:Ruby/DBI}[http://rubyforge.org/projects/ruby-dbi] and
|
115
|
+
at least one driver from MySQL/Ruby, postgres-pr, or
|
116
|
+
{RubyForge:ruby-oci8}[http://ruby-oci8.rubyforge.org/]
|
117
|
+
(note that ruby-oci8 can only work with ruby-dbi 0.2.2).
|
118
|
+
|
119
|
+
|
120
|
+
== INSTALL
|
121
|
+
|
122
|
+
In the bioruby source directory (such as bioruby-x.x.x/), run setup.rb
|
123
|
+
as follows:
|
124
|
+
|
125
|
+
% su
|
126
|
+
# ruby setup.rb
|
127
|
+
|
128
|
+
These simple step installs this program under the default location of
|
129
|
+
Ruby libraries. You can also install files into your favorite directory
|
130
|
+
by supplying setup.rb some options. Try "ruby setup.rb --help".
|
131
|
+
|
132
|
+
If your operating system supports 'sudo' command (such as Mac OS X),
|
133
|
+
try the following procedure instead of the above.
|
134
|
+
|
135
|
+
% sudo ruby setup.rb
|
136
|
+
|
137
|
+
For older version users: "install.rb" is now renamed to "setup.rb".
|
138
|
+
The options "config", "setup", and "install" are still available.
|
139
|
+
|
140
|
+
% ruby setup.rb config
|
141
|
+
% ruby setup.rb setup
|
142
|
+
% su
|
143
|
+
# ruby setup.rb install
|
144
|
+
|
145
|
+
You can run tests by
|
146
|
+
|
147
|
+
% ruby setup.rb test
|
148
|
+
|
149
|
+
and run
|
150
|
+
|
151
|
+
% ruby setup.rb --help
|
152
|
+
|
153
|
+
for more details.
|
154
|
+
|
155
|
+
=== RubyGems
|
156
|
+
|
157
|
+
If you are using RubyGems, just type
|
158
|
+
|
159
|
+
% gems install bio
|
160
|
+
|
161
|
+
|
162
|
+
== SETUP
|
163
|
+
|
164
|
+
If you want to use the OBDA (Open Bio Database Access) to obtain database
|
165
|
+
entries, copy a sample configuration file in the BioRuby distribution
|
166
|
+
|
167
|
+
bioruby-x.x.x/etc/bioinformatics/seqdatabase.ini
|
168
|
+
|
169
|
+
to
|
170
|
+
|
171
|
+
/etc/bioinformatics/seqdatabase.ini (system wide configuration)
|
172
|
+
|
173
|
+
or
|
174
|
+
|
175
|
+
~/.bioinformatics/seqdatabase.ini (personal configuration)
|
176
|
+
|
177
|
+
and change the contents according to your preference. For more
|
178
|
+
information on the OBDA, see http://obda.open-bio.org/ .
|
179
|
+
|
180
|
+
|
181
|
+
== USAGE
|
182
|
+
|
183
|
+
You can load all BioRuby classes just by requiring 'bio.rb'. All the
|
184
|
+
BioRuby classes and modules are located under the module name 'Bio' to
|
185
|
+
separate the name space.
|
186
|
+
|
187
|
+
#!/usr/bin/env ruby
|
188
|
+
require 'bio'
|
189
|
+
|
190
|
+
You can also read other documentation in the 'doc' directory.
|
191
|
+
|
192
|
+
bioruby-x.x.x/doc/
|
193
|
+
|
194
|
+
=== RubyGems
|
195
|
+
|
196
|
+
With RubyGems, you need to load 'rubygems' library before using 'bio'.
|
197
|
+
|
198
|
+
#!/usr/bin/env ruby
|
199
|
+
require 'rubygems'
|
200
|
+
require 'bio'
|
201
|
+
|
202
|
+
With old version of RubyGems, use 'require_gem' which was deprecated in
|
203
|
+
RubyGems 0.9.0 and removed in RubyGems 1.0.1.
|
204
|
+
|
205
|
+
#!/usr/bin/env ruby
|
206
|
+
require 'rubygems'
|
207
|
+
require_gem 'bio'
|
208
|
+
|
209
|
+
|
210
|
+
== LICENSE
|
211
|
+
|
212
|
+
BioRuby can be freely distributed under the same terms as Ruby.
|
213
|
+
|
214
|
+
Note that setup.rb included in the BioRuby package comes from
|
215
|
+
{RAA:setup}[http://raa.ruby-lang.org/project/setup/] developed by Minero Aoki
|
216
|
+
(http://i.loveruby.net/en/projects/setup/).
|
217
|
+
|
218
|
+
|
219
|
+
== CONTACT
|
220
|
+
|
221
|
+
Current staff of the BioRuby project can be reached by sending e-mail
|
222
|
+
to <staff@bioruby.org>.
|
223
|
+
|
data/README_DEV.rdoc
ADDED
@@ -0,0 +1,285 @@
|
|
1
|
+
= README.DEV
|
2
|
+
|
3
|
+
Copyright:: Copyright (C) 2005, 2006 Toshiaki Katayama <k@bioruby.org>
|
4
|
+
Copyright:: Copyright (C) 2006, 2008 Jan Aerts <jandot@bioruby.org>
|
5
|
+
|
6
|
+
= HOW TO CONTRIBUTE TO THE BIORUBY PROJECT?
|
7
|
+
|
8
|
+
There are many possible ways to contribute to the BioRuby project,
|
9
|
+
such as:
|
10
|
+
|
11
|
+
* Join the discussion on the BioRuby mailing list
|
12
|
+
* Send a bug report or write a bug fix patch
|
13
|
+
* Add and correct documentation
|
14
|
+
* Develop code for new features, etc.
|
15
|
+
|
16
|
+
All of these are welcome! However, this document describes the last option,
|
17
|
+
how to contribute your code to the BioRuby distribution.
|
18
|
+
|
19
|
+
We would like to include your contribution as long as the scope of
|
20
|
+
your module meets the field of bioinformatics.
|
21
|
+
|
22
|
+
== Git
|
23
|
+
|
24
|
+
Bioruby is now under git source control at http://github.com/bioruby/bioruby.
|
25
|
+
There are two basic ways to contribute: with patches or pull requests. Both are
|
26
|
+
explained on the bioruby wiki at http://bioruby.open-bio.org/wiki.
|
27
|
+
|
28
|
+
= LICENSE
|
29
|
+
|
30
|
+
If you would like your module to be included in the BioRuby distribution,
|
31
|
+
you need to give us right to change the license of your module to make it
|
32
|
+
compatible with other modules in BioRuby.
|
33
|
+
|
34
|
+
BioRuby was previously distributed under the LGPL license, but now is
|
35
|
+
distributed under the same terms as Ruby.
|
36
|
+
|
37
|
+
= CODING STYLE
|
38
|
+
|
39
|
+
You will need to follow the typical coding styles of the BioRuby modules:
|
40
|
+
|
41
|
+
== Use the following naming conventions
|
42
|
+
|
43
|
+
* CamelCase for module and class names
|
44
|
+
* '_'-separated_lowercase for method names
|
45
|
+
* '_'-separated_lowercase for variable names
|
46
|
+
* all UPPERCASE for constants
|
47
|
+
|
48
|
+
== Indentation must not include tabs
|
49
|
+
|
50
|
+
* Use 2 spaces for indentation.
|
51
|
+
* Don't replace spaces to tabs.
|
52
|
+
|
53
|
+
== Comments
|
54
|
+
|
55
|
+
Don't use <tt>=begin</tt> and <tt>=end</tt> blocks for comments. If you need to
|
56
|
+
add comments, include it in the RDoc documentation.
|
57
|
+
|
58
|
+
== Documentation should be written in the RDoc format in the source code
|
59
|
+
|
60
|
+
The RDoc format is becoming the popular standard for Ruby documentation.
|
61
|
+
We are now in transition from the previously used RD format to the RDoc
|
62
|
+
format in API documentation.
|
63
|
+
|
64
|
+
Additional tutorial documentation and working examples are encouraged
|
65
|
+
with your contribution. You may use the header part of the file for
|
66
|
+
this purpose as demonstrated in the previous section.
|
67
|
+
|
68
|
+
== Standard documentation
|
69
|
+
|
70
|
+
=== of files
|
71
|
+
|
72
|
+
Each file should start with a header, which covers the following topics:
|
73
|
+
* copyright
|
74
|
+
* license
|
75
|
+
* description of the file (_not_ the classes; see below)
|
76
|
+
* any references, if appropriate
|
77
|
+
|
78
|
+
The header should be formatted as follows:
|
79
|
+
|
80
|
+
#
|
81
|
+
# = bio/db/hoge.rb - Hoge database parser classes
|
82
|
+
#
|
83
|
+
# Copyright:: Copyright (C) 2001, 2003-2005 Bio R. Hacker <brh@example.org>,
|
84
|
+
# Copyright:: Copyright (C) 2006 Chem R. Hacker <crh@example.org>
|
85
|
+
#
|
86
|
+
# License:: The Ruby License
|
87
|
+
#
|
88
|
+
# == Description
|
89
|
+
#
|
90
|
+
# This file contains classes that implement an interface to the Hoge database.
|
91
|
+
#
|
92
|
+
# == References
|
93
|
+
#
|
94
|
+
# * Hoge F. et al., The Hoge database, Nucleic. Acid. Res. 123:100--123 (2030)
|
95
|
+
# * http://hoge.db/
|
96
|
+
#
|
97
|
+
|
98
|
+
require 'foo'
|
99
|
+
|
100
|
+
module Bio
|
101
|
+
|
102
|
+
autoload :Bar, 'bio/bar'
|
103
|
+
|
104
|
+
class Hoge
|
105
|
+
:
|
106
|
+
end # Hoge
|
107
|
+
|
108
|
+
end # Bio
|
109
|
+
|
110
|
+
=== of classes and methods within those files
|
111
|
+
|
112
|
+
Classes and methods should be documented in a standardized format, as in the
|
113
|
+
following example (from lib/bio/sequence.rb):
|
114
|
+
|
115
|
+
# == Description
|
116
|
+
#
|
117
|
+
# Bio::Sequence objects represent annotated sequences in bioruby.
|
118
|
+
# A Bio::Sequence object is a wrapper around the actual sequence,
|
119
|
+
# represented as either a Bio::Sequence::NA or a Bio::Sequence::AA object.
|
120
|
+
# For most users, this encapsulation will be completely transparent.
|
121
|
+
# Bio::Sequence responds to all methods defined for Bio::Sequence::NA/AA
|
122
|
+
# objects using the same arguments and returning the same values (even though
|
123
|
+
# these methods are not documented specifically for Bio::Sequence).
|
124
|
+
#
|
125
|
+
# == Usage
|
126
|
+
#
|
127
|
+
# require 'bio'
|
128
|
+
#
|
129
|
+
# # Create a nucleic or amino acid sequence
|
130
|
+
# dna = Bio::Sequence.auto('atgcatgcATGCATGCAAAA')
|
131
|
+
# rna = Bio::Sequence.auto('augcaugcaugcaugcaaaa')
|
132
|
+
# aa = Bio::Sequence.auto('ACDEFGHIKLMNPQRSTVWYU')
|
133
|
+
#
|
134
|
+
# # Print in FASTA format
|
135
|
+
# puts dna.output(:fasta)
|
136
|
+
#
|
137
|
+
# # Print all codons
|
138
|
+
# dna.window_search(3,3) do |codon|
|
139
|
+
# puts codon
|
140
|
+
# end
|
141
|
+
#
|
142
|
+
class Sequence
|
143
|
+
|
144
|
+
# Create a new Bio::Sequence object
|
145
|
+
#
|
146
|
+
# s = Bio::Sequence.new('atgc')
|
147
|
+
# puts s # => 'atgc'
|
148
|
+
#
|
149
|
+
# Note that this method does not intialize the contained sequence
|
150
|
+
# as any kind of bioruby object, only as a simple string
|
151
|
+
#
|
152
|
+
# puts s.seq.class # => String
|
153
|
+
#
|
154
|
+
# See Bio::Sequence#na, Bio::Sequence#aa, and Bio::Sequence#auto
|
155
|
+
# for methods to transform the basic String of a just created
|
156
|
+
# Bio::Sequence object to a proper bioruby object
|
157
|
+
# ---
|
158
|
+
# *Arguments*:
|
159
|
+
# * (required) _str_: String or Bio::Sequence::NA/AA object
|
160
|
+
# *Returns*:: Bio::Sequence object
|
161
|
+
def initialize(str)
|
162
|
+
@seq = str
|
163
|
+
end
|
164
|
+
|
165
|
+
# The sequence identifier. For example, for a sequence
|
166
|
+
# of Genbank origin, this is the accession number.
|
167
|
+
attr_accessor :entry_id
|
168
|
+
|
169
|
+
# An Array of Bio::Feature objects
|
170
|
+
attr_accessor :features
|
171
|
+
end # Sequence
|
172
|
+
|
173
|
+
Preceding the class definition (<tt>class Sequence</tt>), there is at least a
|
174
|
+
description and a usage example. Please use the +Description+ and +Usage+
|
175
|
+
headings. If appropriate, refer to other classes that interact with or are
|
176
|
+
related to the class.
|
177
|
+
|
178
|
+
The code in the usage example should, if possible, be in a format that a user
|
179
|
+
can copy-and-paste into a new script to run. It should illustrate the most
|
180
|
+
important uses of the class. If possible and if it would not clutter up the
|
181
|
+
example too much, try to provide any input data directly into the usage example,
|
182
|
+
instead of refering to ARGV or ARGF for input.
|
183
|
+
|
184
|
+
dna = Bio::Sequence.auto('atgcatgcATGCATGCAAAA')
|
185
|
+
|
186
|
+
Otherwise, describe the input shortly, for example:
|
187
|
+
|
188
|
+
# input should be string consisting of nucleotides
|
189
|
+
dna = Bio::Sequence.auto(ARGF.read)
|
190
|
+
|
191
|
+
Methods should be preceded by a comment that describes what the method does,
|
192
|
+
including any relevant usage examples. (In contrast to the documentation for
|
193
|
+
the class itself, headings are not required.) In addition, any arguments should
|
194
|
+
be listed, as well as the type of thing that is returned by the method. The
|
195
|
+
format of this information is as follows:
|
196
|
+
|
197
|
+
# ---
|
198
|
+
# *Arguments*:
|
199
|
+
# * (required) _str_: String or Bio::Sequence::NA
|
200
|
+
# * (optional) _nr_: a number that means something
|
201
|
+
# *Returns*:: true or false
|
202
|
+
|
203
|
+
Attribute accessors can be preceded by a short description.
|
204
|
+
|
205
|
+
== Exception handling
|
206
|
+
|
207
|
+
Don't use
|
208
|
+
|
209
|
+
$stderr.puts "WARNING"
|
210
|
+
|
211
|
+
in your code. Instead, try to avoid printing error messages. For fatal errors,
|
212
|
+
use +raise+ with an appropriate message.
|
213
|
+
|
214
|
+
== Testing code should use 'test/unit'
|
215
|
+
|
216
|
+
Unit tests should come with your modules by which you can assure what
|
217
|
+
you meant to do with each method. The test code is useful to make
|
218
|
+
maintenance easy and ensure stability. The use of
|
219
|
+
|
220
|
+
if __FILE__ == $0
|
221
|
+
|
222
|
+
is deprecated.
|
223
|
+
|
224
|
+
== Using autoload
|
225
|
+
|
226
|
+
To quicken the initial load time we have replaced most of 'require' to
|
227
|
+
'autoload' since BioRuby version 0.7. During this change, we have found
|
228
|
+
some tips:
|
229
|
+
|
230
|
+
You should not separate the same namespace into several files.
|
231
|
+
|
232
|
+
* For example, if you have separated definitions of the Bio::Foo
|
233
|
+
class into two files (e.g. 'bio/foo.rb' and 'bio/bar.rb'), you
|
234
|
+
need to resolve the dependencies (including the load order)
|
235
|
+
yourself.
|
236
|
+
|
237
|
+
* If you have a defined Bio::Foo in 'bio/foo.rb' and a defined
|
238
|
+
Bio::Foo::Bar in 'bio/foo/bar.rb' add the following line in the
|
239
|
+
'bio/foo.rb' file:
|
240
|
+
|
241
|
+
autoload :Bar, 'bio/foo/bar'
|
242
|
+
|
243
|
+
You should not put several top level namespaces in one file.
|
244
|
+
|
245
|
+
* For example, if you have Bio::A, Bio::B and Bio::C in the file
|
246
|
+
'bio/foo.rb', you need
|
247
|
+
|
248
|
+
autoload :A, 'bio/foo'
|
249
|
+
autoload :B, 'bio/foo'
|
250
|
+
autoload :C, 'bio/foo'
|
251
|
+
|
252
|
+
to load the module automatically (instead of require 'bio/foo').
|
253
|
+
In this case, you should put them under the new namespace like
|
254
|
+
Bio::Foo::A, Bio::Foo::B and Bio::Foo::C in the file 'bio/foo',
|
255
|
+
then use
|
256
|
+
|
257
|
+
autoload :Foo, 'bio/foo'
|
258
|
+
|
259
|
+
so autoload can be written in 1 line.
|
260
|
+
|
261
|
+
= NAMESPACE
|
262
|
+
|
263
|
+
Your module should be located under the top-level module Bio and put under
|
264
|
+
the 'bioruby/lib/bio' directory. The class/module names and the
|
265
|
+
file names should be short and descriptive.
|
266
|
+
|
267
|
+
There are already several sub directories in 'bioruby/lib':
|
268
|
+
|
269
|
+
bio/*.rb -- general and widely used basic classes
|
270
|
+
bio/appl/ -- wrapper and parser for the external applications
|
271
|
+
bio/data/ -- basic biological data
|
272
|
+
bio/db/ -- flatfile database entry parsers
|
273
|
+
bio/io/ -- I/O interfaces for files, RDB, web services etc.
|
274
|
+
bio/util/ -- utilities and algorithms for bioinformatics
|
275
|
+
|
276
|
+
If your module doesn't match any of the above, please propose
|
277
|
+
an appropriate directory name when you contribute. Please let the staff
|
278
|
+
discuss on namespaces (class names), API (method names) before commiting
|
279
|
+
a new module or making changes on existing modules.
|
280
|
+
|
281
|
+
= MAINTENANCE
|
282
|
+
|
283
|
+
Finally, please maintain the code you've contributed. Please let us know (on
|
284
|
+
the bioruby list) before you commit, so that users can discuss on the change.
|
285
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
#
|
2
|
+
# = Rakefile - helper of developement and packaging
|
3
|
+
#
|
4
|
+
# Copyright:: Copyright (C) 2009 Naohisa Goto <ng@bioruby.org>
|
5
|
+
# License:: The Ruby License
|
6
|
+
#
|
7
|
+
|
8
|
+
require 'rubygems'
|
9
|
+
require 'erb'
|
10
|
+
require 'rake/testtask'
|
11
|
+
require 'rake/packagetask'
|
12
|
+
require 'rake/gempackagetask'
|
13
|
+
|
14
|
+
task :default => "test"
|
15
|
+
|
16
|
+
Rake::TestTask.new do |t|
|
17
|
+
t.test_files = FileList["test/{unit,functional}/**/test_*.rb"]
|
18
|
+
end
|
19
|
+
|
20
|
+
# files not included in gem but included in tar archive
|
21
|
+
tar_additional_files = []
|
22
|
+
|
23
|
+
GEM_SPEC_FILE = "bioruby.gemspec"
|
24
|
+
GEM_SPEC_TEMPLATE_FILE = "bioruby.gemspec.erb"
|
25
|
+
|
26
|
+
# gets gem spec string
|
27
|
+
gem_spec_string = ERB.new(File.read(GEM_SPEC_TEMPLATE_FILE)).result
|
28
|
+
|
29
|
+
# gets gem spec object
|
30
|
+
spec = eval(gem_spec_string)
|
31
|
+
|
32
|
+
# adds notice of automatically generated file
|
33
|
+
gem_spec_string = "# This file is automatically generated from #{GEM_SPEC_TEMPLATE_FILE} and\n# should NOT be edited by hand.\n# \n" + gem_spec_string
|
34
|
+
|
35
|
+
# compares current gemspec file and newly generated gemspec string
|
36
|
+
current_string = File.read(GEM_SPEC_FILE) rescue nil
|
37
|
+
if current_string and current_string != gem_spec_string then
|
38
|
+
#Rake::Task[GEM_SPEC_FILE].invoke
|
39
|
+
flag_update_gemspec = true
|
40
|
+
else
|
41
|
+
flag_update_gemspec = false
|
42
|
+
end
|
43
|
+
|
44
|
+
desc "Update gem spec file"
|
45
|
+
task :gemspec => GEM_SPEC_FILE
|
46
|
+
|
47
|
+
desc "Update #{GEM_SPEC_FILE}"
|
48
|
+
file GEM_SPEC_FILE => [ GEM_SPEC_TEMPLATE_FILE, 'Rakefile' ] do |t|
|
49
|
+
puts "creates #{GEM_SPEC_FILE}"
|
50
|
+
File.open(t.name, 'w') do |w|
|
51
|
+
w.print gem_spec_string
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
task :package => [ GEM_SPEC_FILE ] do
|
56
|
+
Rake::Task[GEM_SPEC_FILE].invoke if flag_update_gemspec
|
57
|
+
end
|
58
|
+
|
59
|
+
Rake::PackageTask.new("bioruby") do |pkg|
|
60
|
+
#pkg.package_dir = "./pkg"
|
61
|
+
pkg.need_tar_gz = true
|
62
|
+
pkg.package_files.import(spec.files)
|
63
|
+
pkg.package_files.include(*tar_additional_files)
|
64
|
+
pkg.version = spec.version
|
65
|
+
end
|
66
|
+
|
67
|
+
Rake::GemPackageTask.new(spec) do |pkg|
|
68
|
+
#pkg.package_dir = "./pkg"
|
69
|
+
end
|
70
|
+
|
data/bin/bioruby
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
#
|
3
|
+
# = BioRuby shell - command line interface for the BioRuby library
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright (C) 2005, 2006, 2007
|
6
|
+
# Toshiaki Katayama <k@bioruby.org>
|
7
|
+
# License:: The Ruby License
|
8
|
+
#
|
9
|
+
# $Id: bioruby,v 1.21 2007/07/26 10:46:46 k Exp $
|
10
|
+
#
|
11
|
+
|
12
|
+
begin
|
13
|
+
require 'rubygems'
|
14
|
+
gem 'bio', '>= 1.1.0'
|
15
|
+
rescue LoadError
|
16
|
+
require 'bio'
|
17
|
+
end
|
18
|
+
require 'bio/shell'
|
19
|
+
|
20
|
+
# required to run commands (getseq, ls etc.)
|
21
|
+
include Bio::Shell
|
22
|
+
|
23
|
+
# setup command line options, working directory, and irb configurations
|
24
|
+
Bio::Shell::Setup.new
|
25
|
+
|
26
|
+
# loading workspace and command history
|
27
|
+
Bio::Shell.load_session
|
28
|
+
|
29
|
+
# main loop
|
30
|
+
if Bio::Shell.cache[:rails]
|
31
|
+
Bio::Shell.cache[:rails].join
|
32
|
+
else
|
33
|
+
Signal.trap("SIGINT") do
|
34
|
+
Bio::Shell.cache[:irb].signal_handle
|
35
|
+
end
|
36
|
+
|
37
|
+
catch(:IRB_EXIT) do
|
38
|
+
Bio::Shell.cache[:irb].eval_input
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
# saving workspace, command history and configuration before exit
|
43
|
+
Bio::Shell.save_session
|
44
|
+
|
data/bin/br_biofetch.rb
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
#
|
3
|
+
# = biofetch - BioFetch client
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright (C) 2002
|
6
|
+
# Toshiaki Katayama <k@bioruby.org>
|
7
|
+
# License:: The Ruby License
|
8
|
+
#
|
9
|
+
# $Id: br_biofetch.rb,v 1.4 2007/04/05 23:35:39 trevor Exp $
|
10
|
+
#
|
11
|
+
|
12
|
+
require 'bio/io/fetch'
|
13
|
+
|
14
|
+
def usage
|
15
|
+
default_url = 'http://bioruby.org/cgi-bin/biofetch.rb'
|
16
|
+
another_url = 'http://www.ebi.ac.uk/cgi-bin/dbfetch'
|
17
|
+
puts "#{$0} [-s[erver] #{another_url}] db id [style] [format]"
|
18
|
+
puts " server : URL of the BioFetch CGI (default is #{default_url})"
|
19
|
+
puts " db : database name (embl, genbank, etc.)"
|
20
|
+
puts " id : entry id"
|
21
|
+
puts " style : 'raw' or 'html' (default is 'raw')"
|
22
|
+
puts " format : change the output format ('default', 'fasta', etc.)"
|
23
|
+
end
|
24
|
+
|
25
|
+
if ARGV.empty? or ARGV[0] =~ /^--?h/
|
26
|
+
usage
|
27
|
+
exit 1
|
28
|
+
end
|
29
|
+
|
30
|
+
case ARGV[0]
|
31
|
+
when /^--?s/ # User specified server
|
32
|
+
ARGV.shift
|
33
|
+
serv = Bio::Fetch.new(ARGV.shift)
|
34
|
+
puts serv.fetch(*ARGV)
|
35
|
+
when /^--?e/ # EBI server
|
36
|
+
ARGV.shift
|
37
|
+
serv = Bio::Fetch.new('http://www.ebi.ac.uk/cgi-bin/dbfetch')
|
38
|
+
puts serv.fetch(*ARGV)
|
39
|
+
when /^--?r/ # BioRuby server
|
40
|
+
ARGV.shift
|
41
|
+
serv = Bio::Fetch.new('http://bioruby.org/cgi-bin/biofetch.rb')
|
42
|
+
puts serv.fetch(*ARGV)
|
43
|
+
else # Default server
|
44
|
+
puts Bio::Fetch.query(*ARGV)
|
45
|
+
end
|
46
|
+
|
47
|
+
|