Edited wiki page PhyloBioRuby through web user interface.

[jalview.git] / wiki / PhyloBioRuby.wiki

diff --git a/wiki/PhyloBioRuby.wiki b/wiki/PhyloBioRuby.wiki
index bd8807d..a3be960 100644 (file)
--- a/wiki/PhyloBioRuby.wiki
+++ b/wiki/PhyloBioRuby.wiki
@@ -23,6 +23,18 @@ Copyright (C) 2011 Christian M Zmasek. All rights reserved.
 
 === Reading in a Multiple Sequence Alignment from a File ===
 
+This automatically determines the format
+{{{
+ff = Bio::FlatFile.auto('bcl2.fasta')
+ff.each_entry do |entry|
+  puts entry.entry_id          # identifier of the entry
+  puts entry.definition        # definition of the entry
+  puts entry.seq               # sequence data of the entry
+end
+}}}
+
+==== ClustalW Format ====
+
 The following example shows how to read in a *ClustalW*-formatted multiple sequence alignment.
 
 {{{
@@ -43,11 +55,41 @@ msa.each do |entry|
 end
 }}}
 
+==== FASTA Format ====
+
+The following example shows how to read in a *FASTA*-formatted multiple sequence file. (_This seems a little clumsy, I wonder if there is a more direct way, avoiding the creation of an array.)
+{{{
+#!/usr/bin/env ruby
+require 'bio'
+
+# Reads in a FASTA-formatted multiple sequence alignment (which does
+# not have to be aligned, though) and stores its sequences in
+# array 'seq_ary'.
+seq_ary = Array.new
+fasta_seqs = Bio::Alignment::MultiFastaFormat.new(File.open('infile.fasta').read)
+fasta_seqs.entries.each do |seq|
+  seq_ary.push(seq)
+end
+
+# Creates a multiple sequence alignment (possibly unaligned) named
+# 'seqs' from array 'seq_ary'.
+seqs = Bio::Alignment.new(seq_ary)
+
+# Prints each sequence to the console.
+seqs.each { |seq| puts seq.to_s }
+
+# Writes multiple sequence alignment (possibly unaligned) 'seqs'
+# to a file in PHYLIP format.
+File.open('outfile.phylip', 'w') do |f|
+  f.write(seqs.output(:phylip))
+end
+}}}
+
 Relevant API documentation:
 
  * [http://bioruby.open-bio.org/rdoc/classes/Bio/ClustalW/Report.html Bio::ClustalW::Report]
  * [http://bioruby.open-bio.org/rdoc/classes/Bio/Alignment.html Bio::Alignment]
- * [http://bioruby.open-bio.org/rdoc/classes/Bio/Sequence.html         Bio::Sequence]
+ * [http://bioruby.open-bio.org/rdoc/classes/Bio/Sequence.html Bio::Sequence]
 
 === Writing a Multiple Sequence Alignment to a File ===