shuffle 0.1.0 → 0.1.1

data/README.md

@@ -1 +1,18 @@
-http://www.youtube.com/watch?v=xFZYJIwfUbo
+#Shuffle
+###Evan Senter
+
+_Altschul, S. F., & Erickson, B. W. (1985). Significance of nucleotide sequence alignments: a method for random sequence permutation that preserves dinucleotide and codon usage. Molecular biology and evolution, 2(6), 526–38. Retrieved from http://www.ncbi.nlm.nih.gov/pubmed/3870875_
+
+    shuffler = Shuffle.new("AGACATAAAGTTCCGTACTGCCGGGAT")
+    puts (dishuffled_sequence = shuffler.dishuffle)
+    #=> AGAAGTACAATCGGTACGATTGGCCCT
+    shuffler.valid?(dishuffled_sequence, 2)
+    #=> true (Shuffler preserved the di-token frequency)
+    shuffler.valid?(dishuffled_sequence, 3)
+    #=> false-ish (Shuffler does not guarantee to preserve the tri-token frequency)
+    puts (trishuffled_sequence = shuffler.shuffle(3))
+    #=> AGTACTGCCGTTCCGGGATAAAGACAT
+    shuffler.valid?(trishuffled_sequence, 3)
+    #=> true
+
+[motivation.](http://www.youtube.com/watch?v=xFZYJIwfUbo)

data/lib/shuffle.rb

@@ -25,8 +25,14 @@ class Shuffle
     rejoin ? shuffled_sequence.join : shuffled_sequence
   end
   
-  def validate(size)
-    frequency(sequence.each_cons(size)) == frequency(shuffler(size).each_cons(size))
+  def valid?(other_sequence, size)
+    split_other_sequence = other_sequence.is_a?(String) && sequence !~ /\s/ ? other_sequence.split(//) : other_sequence
+    
+    frequency(sequence.each_cons(size)) == frequency(split_other_sequence.each_cons(size))
+  end
+  
+  def validate_random(size)
+    valid?(shuffler(size), size)
   end
   
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shuffle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: