Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
153 lines (109 sloc) 4 KB
# This document is generated with a version of rd2html (part of Hiki)
#
# A possible test run could be from rdtool (on Debian package rdtool)
#
# rd2 $BIORUBYPATH/doc/Tutorial.rd
#
# or with style sheet:
#
# rd2 -r rd/rd2html-lib.rb --with-css=bioruby.css $BIORUBYPATH/doc/Tutorial.rd > ~/bioruby.html
#
# in Debian:
#
# rd2 -r rd/rd2html-lib --with-css="../lib/bio/shell/rails/vendor/plugins/bioruby/generators/bioruby/templates/bioruby.css" Tutorial.rd > Tutorial.rd.html
#
# A common problem is tabs in the text file! TABs are not allowed.
#
# To add tests run Toshiaki's bioruby shell and paste in the query plus
# results.
#
# To run the embedded Ruby doctests you can use the rubydoctest tool, part
# of the bioruby-support repository at http://github.com/pjotrp/bioruby-support/
#
=begin
#doctest Testing bioruby
= Bio::PhyloXML Tutorial
* Copyright (C) 2001-2003 KATAYAMA Toshiaki <k .at. bioruby.org>
* Copyright (C) 2005-2009 Pjotr Prins, Naohisa Goto and others
= PhyloXML
PhyloXML is an XML language for saving, analyzing and exchanging data of
annotated phylogenetic trees. PhyloXML parser in BioRuby is implemented in
Bio::PhyloXML::Parser and writer in Bio::PhyloXML::Writer.
More information at www.phyloxml.org
== Install
% gem install bio-phyloxml
In addition to bio-phyloxml, dependent gems such as bio and libxml-ruby
will automatically be installed.
== Parsing a file
require 'bio-phyloxml'
# Create new phyloxml parser
phyloxml = Bio::PhyloXML::Parser.new('example.xml')
# Print the names of all trees in the file
phyloxml.each do |tree|
puts tree.name
end
If there are several trees in the file, you can access the one you wish by an index
tree = phyloxml[3]
You can use all Bio::Tree methods on the tree, since PhyloXML::Tree inherits from Bio::Tree. For example,
tree.leaves.each do |node|
puts node.name
end
PhyloXML files can hold additional information besides phylogenies at the end of the file. This info can be accessed through the 'other' array of the parser object.
phyloxml = Bio::PhyloXML::Parser.new('example.xml')
while tree = phyloxml.next_tree
# do stuff with trees
end
puts phyloxml.other
== Writing a file
# Create new phyloxml writer
writer = Bio::PhyloXML::Writer.new('tree.xml')
# Write tree to the file tree.xml
writer.write(tree1)
# Add another tree to the file
writer.write(tree2)
== Retrieving data
Here is an example of how to retrieve the scientific name of the clades.
require 'bio-phyloxml'
phyloxml = Bio::PhyloXML::Parser.new('ncbi_taxonomy_mollusca.xml')
phyloxml.each do |tree|
tree.each_node do |node|
print "Scientific name: ", node.taxonomies[0].scientific_name, "\n"
end
end
== Retrieving 'other' data
require 'bio-phyloxml'
phyloxml = Bio::PhyloXML::Parser.new('phyloxml_examples.xml')
while tree = phyloxml.next_tree
#do something with the trees
end
p phyloxml.other
puts "\n"
#=> output is an object representation
#Print in a readable way
puts phyloxml.other[0].to_xml, "\n"
#=>:
#
#<align:alignment xmlns:align="http://example.org/align">
# <seq name="A">acgtcgcggcccgtggaagtcctctcct</seq>
# <seq name="B">aggtcgcggcctgtggaagtcctctcct</seq>
# <seq name="C">taaatcgc--cccgtgg-agtccc-cct</seq>
#</align:alignment>
#Once we know whats there, lets output just sequences
phyloxml.other[0].children.each do |node|
puts node.value
end
#=>
#
#acgtcgcggcccgtggaagtcctctcct
#aggtcgcggcctgtggaagtcctctcct
#taaatcgc--cccgtgg-agtccc-cct
= APPENDIX
=== Troubleshooting libxml-ruby installation problem
If you get "Failed to build gem native extension" error, you may need to
install the GNOME Libxml2 XML toolkit library and development files.
On Debian or Ubuntu,
sudo aptitude install libxml2-dev
On RedHat or CentOS,
sudo yum install libxml2-devel
On other platforms, see ((<URL:http://www.xmlsoft.org/>)).
=end