ruby-plot 0.0.2

data/README

@@ -0,0 +1,22 @@
+README
+svg_roc_plot.rb
+Copyright 2010 vorgrimmler <dv(a_t)fdm.uni-freiburg.de>
+This ruby program exports inputs data(from true-positive-rate and false-positive-rate files) to a *.svg file using gnuplot. Depending on the amount of input data is possible to create 1 to n curves in one plot. 
+Gnuplot is needed. Please install befor using svg_roc_plot. "sudo apt-get install gnuplot" (on debian systems)
+
+Usage: ruby svg_roc_plot.rb ([filename_1] [filename_2]) ... ([filename_1] [filenam_2])
+ cmd=filename_1 : This should be the filename of the ture-positiv-rate data.
+ cmd=filename_2 : This should be the filename of the false-positiv-rate data.
+ Only pairs of input files are allowed but at least one.
+ Each input file has to provide one float number from 0 to 100 per line.
+
+
+svg_roc_plot_method.rb
+Copyright 2010 vorgrimmler <dv(a_t)fdm.uni-freiburg.de>
+This ruby method (svg_roc_plot) exports inputs data(from true-positive-rate and false-positive-rate arrays) to a *.svg file using gnuplot. Depending on the amount of input data is possible to create 1 to n curves in one plot.
+Gnuplot is needed. Please install befor using svg_roc_plot. "sudo apt-get install gnuplot" (on debian systems).
+
+Usage: svg_roc_plot (svg_path(?), title(string), x-lable(string), y-lable(sting), algorithms(array), true_pos_data1(array), false_pos_data1(array), ..., true_pos_data_n(array), false_pos_data_n(array))
+Only pairs of data are allowed but at least one.
+Each data array has to provide one float/int number from 0 to 100 per entry.
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-plot"
+    gem.summary = %Q{gnuplot wrapper for ruby, especially for plotting roc curves into svg files}
+    gem.description = %Q{}
+    gem.email = "vorgrimmlerdavid@gmx.de"
+    gem.homepage = "http://github.com/davor/ruby-plot"
+    gem.authors = ["David Vorgrimmler", "Martin Gütlein"]
+		['gnuplot'].each do |dep|
+		  gem.add_dependency dep
+		end
+		gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
+		gem.files.include %w(lib/ruby-plot.rb)
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-plot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/plot_bars.rb

@@ -0,0 +1,63 @@
+
+module RubyPlot
+
+  def self.plot_bars(title = '', measures = [], algorithms = [], output_file = '')
+    
+   #puts "'"+title+"',"+measures.inspect+","+algorithms.inspect+","
+    
+    measures = measures.collect{|m| m.gsub(/_/,'-')}
+    
+    Gnuplot.open do |gp|
+      Gnuplot::Plot.new( gp ) do |plot|
+        string = ''
+        (1..measures.length).collect.each do |i|
+          string += '"' + measures[i-1] + '" ' + i.to_s + ".00000 -1 "
+        end
+  
+        plot.terminal 'svg size 800,600 dynamic enhanced fname "Arial" fsize 12 butt'         
+        plot.output   output_file
+        plot.bar    '1.000000'
+        plot.boxwidth '0.9 absolute'
+        plot.style    'fill  solid 1.00 border -1'
+        plot.style    'rectangle back fc lt -3 fillstyle  solid 1.00 border -1'
+        #plot.key    'outside right top vertical Right noreverse enhanced autotitles columnhead nobox'
+        #plot.key "invert reverse Left outside"
+        plot.key "below"
+        
+        plot.style    'histogram clustered gap 3 title  offset character 0, 0, 0'
+  #     plot.datafile 'missing "-"'
+        plot.style    'data histograms'
+        plot.xtics    'border in scale 1,0.5 nomirror  offset character 0, 0, 0'
+        #plot.xtics    'norangelimit'
+        plot.xtics    'rotate'
+        #plot.xtics    string
+        plot.title    title
+        plot.rrange   '[ * : * ] noreverse nowriteback  # (currently [0.00000:10.0000])'
+        plot.trange   '[ * : * ] noreverse nowriteback  # (currently [-5.00000:5.00000])'
+        plot.urange   '[ * : * ] noreverse nowriteback  # (currently [-5.00000:5.00000])'
+        plot.vrange   '[ * : * ] noreverse nowriteback  # (currently [-5.00000:5.00000])'
+  #     plot.ylabel   'offset character 0, 0, 0 font "" textcolor lt -1 rotate by 90'
+  #     plot.y2label  'offset character 0, 0, 0 font "" textcolor lt -1 rotate by 90'
+        plot.yrange   '[ 0.00000 : 1.00000 ] noreverse nowriteback'                 #
+        plot.cblabel  'offset character 0, 0, 0 font "" textcolor lt -1 rotate by 90'
+        plot.locale   '"C"'
+       
+        
+  
+        algorithms.each do |algorithm|
+          plot.data << Gnuplot::DataSet.new([ ["A"].concat(measures), algorithm ]) do |ds|
+            ds.using = "2:xtic(1) ti col"
+          end
+        end
+      end
+    end
+    LOGGER.info "plotted "+output_file.to_s
+  end
+  
+  def self.test_plot_bars
+    x = ['ACC_with_very_long_name_consider_that', 'AUC', 'SPEC', 'SENS']
+    data = [['Alg1', 1.00, 1.00, 1.00, 1.00], ['Alg2', 0.75, 0.75, 0.75, 0.75], ['Alg3', 0.50, 0.50, 0.50, 0.50]]
+    plot_bars('Vergleich der Algorithmen', x, data, '/tmp/hist.svg')
+  end
+  
+end

data/lib/plot_lines.rb

@@ -0,0 +1,183 @@
+#!/usr/bin/ruby1.8
+# svg_roc_plot method - svg_roc_plot_method.rb
+#       
+# Copyright 2010 vorgrimmler <dv(a_t)fdm.uni-freiburg.de>
+# This ruby method (svg_roc_plot) exports input data(from true-positive-rate and false-positive-rate arrays) to a *.svg file using gnuplot. Depending on the amount of input data is possible to create 1 to n curves in one plot. 
+# Gnuplot is needed. Please install befor using svg_roc_plot. "sudo apt-get install gnuplot" (on debian systems).
+# Usage: See below.
+
+module RubyPlot
+
+  def self.plot_lines(svg_path, title, x_lable, y_lable, names, x_values, y_values, faint=nil)
+    
+    #LOGGER.debug names.inspect
+    #LOGGER.debug x_values.inspect
+    #LOGGER.debug y_values.inspect
+    
+    data = []
+    (0..x_values.size-1).each do |i|
+      data << y_values[i]
+      data << x_values[i]
+    end
+    
+    #Main
+    STDOUT.sync = true
+    # -----------------------------------------------------
+    # checking input
+    # -----------------------------------------------------
+    # check parameters
+    status=false
+    LOGGER.debug "#{names.length} algs entered"
+    
+    #LOGGER.debug names.inspect
+    #LOGGER.debug data.inspect
+    
+    if names.length != data.length/2
+        status=true
+    end
+    
+    if status
+      raise "Usage: svg_roc_plot (svg_path(?), title(string), x-lable(string), y-lable(sting), algorithms(array), true_pos_data1(array), false_pos_data1(array), ...,  true_pos_data_n(array), false_pos_data_n(array))\n"+
+            "       Only pairs of data are allowed but at least one.\n"+
+            "       Each data array has to provide one float/int number from 0 to 100 per entry."
+    end
+    
+    # gnuplot check
+    gnuplot=`which gnuplot | grep -o gnuplot`
+    if gnuplot == "gnuplot\n"
+      LOGGER.debug "Gnuplot is already installed."
+    else
+      raise "Please install gnuplot.\n"+
+            "sudo apt-get install gnuplot"
+    end
+    
+    dat_number=0
+    
+    output_dat_arr = Array.new
+    
+    
+    # -----------------------------------------------------
+    # create *.dat files of imported data for gnuplot
+    # -----------------------------------------------------
+    # write true/false arrays to one array
+    for i in 0..names.length-1#/2-1
+      true_pos_arr = data[i*2]
+      false_pos_arr = data[i*2+1]
+      #check length of input files
+      if true_pos_arr.length == false_pos_arr.length
+        #LOGGER.debug "Same length!"
+        for j in 0..true_pos_arr.length-1
+          #check if array entries are float format and between 0.0 and 100.0
+          if numeric?(true_pos_arr[j].to_s.tr(',', '.')) && true_pos_arr[j].to_s.tr(',', '.').to_f <= 100 && true_pos_arr[j].to_s.tr(',', '.').to_f >= 0
+            if  numeric?(false_pos_arr[j].to_s.tr(',', '.')) && false_pos_arr[j].to_s.tr(',', '.').to_f <= 100 && false_pos_arr[j].to_s.tr(',', '.').to_f >= 0
+              output_dat_arr[j] = "#{true_pos_arr[j]} #{false_pos_arr[j]}"
+            else
+              raise "The data of #{names[i]}  has not the right formatin at position #{j}\n"+
+                    "The right format is one float/int from 0 to 100 each line (e.g. '0'; '23,34'; '65.87' or '99')"
+            end
+          else
+            raise "The data of #{names[i]}  has not the right formatin at position #{j}+\n"
+                   "The right format is one float/int from 0 to 100 each line (e.g. '0'; '23,34'; '65.87' or '99')"
+          end
+        end
+        #-----------------------------------------------------
+        #write *.dat files
+        #-----------------------------------------------------
+        #write output_dat_arr content in new *.dat file
+        File.open( "data#{i}.dat", "w" ) do |the_file|
+            the_file.puts output_dat_arr
+        end
+        LOGGER.debug "data#{i}.dat created."
+        output_dat_arr.clear
+            
+      else
+        raise "Data pair of #{names[i]} have no the same number of elements."
+      end
+    end
+    
+    # -----------------------------------------------------
+    # create *.plt file for gnuplot
+    # -----------------------------------------------------
+    # 
+    output_plt_arr = Array.new
+    output_plt_arr.push "# Specifies encoding and output format"
+    output_plt_arr.push "set encoding default"
+    #output_plt_arr.push "set terminal svg"
+    output_plt_arr.push 'set terminal svg size 800,600 dynamic enhanced fname "Arial" fsize 12 butt'
+    output_plt_arr.push "set output '#{svg_path}'"
+    output_plt_arr.push ""
+    output_plt_arr.push "# Specifies the range of the axes and appearance"
+    
+    output_plt_arr.push "set xrange [0:100]"
+    output_plt_arr.push "set yrange [0:100]"
+    output_plt_arr.push "set grid lw 0.5"
+    output_plt_arr.push "set title \"#{title}\""
+    output_plt_arr.push "set key below"
+    #output_plt_arr.push "set key invert reverse Left outside"
+    output_plt_arr.push "set xlabel \"#{x_lable}\""
+    output_plt_arr.push "set ylabel \"#{y_lable}\""
+    output_plt_arr.push "set arrow from 0,0 to 100,100 nohead"
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    output_plt_arr.push "# Draws the plot and specifies its appearance ..."
+    output_plt_arr.push "plot \\"#'random_0.dat' using 1:2 title 'random' with lines lw 1, \\"
+    i = 0
+    for i in 0..names.length-1
+      
+      #style = grey[i] ? "lw 1.5 lt 0" : "lw 3" 
+      style = faint!=nil && faint[i] ? "lw 2" : "lw 4"
+      
+      if i == names.length-1
+        output_plt_arr.push " 'data#{i}.dat'  using 2:1 title '#{names[i]}' with lines #{style}"
+      else
+        output_plt_arr.push " 'data#{i}.dat'  using 2:1 title '#{names[i]}' with lines #{style}, \\"
+      end
+    end
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    
+    # -----------------------------------------------------
+    # write *.plt files
+    # -----------------------------------------------------
+    # write output_dat_arr content in new *.dat file
+    File.open( "config.plt", "w" ) do |the_file|
+      the_file.puts output_plt_arr
+    end
+    LOGGER.debug "config.plt created, running gnuplot"
+    
+    # start gnuplot with created *.plt file
+    cmd = "gnuplot config.plt 2>&1"
+    response = ""
+    IO.popen(cmd) do |f| 
+      while line = f.gets
+        response += line
+      end
+    end
+    raise "gnuplot failes (cmd: "+cmd.to_s+", out: "+response.to_s+")" unless $?==0
+    
+    LOGGER.debug "#{svg_path} created. "
+    
+    # -----------------------------------------------------
+    # remove *.plt and *.dat files
+    # -----------------------------------------------------
+    `rm config.plt`
+    LOGGER.debug "config.plt removed."
+    for i in 0..names.length-1
+      `rm data#{i}.dat`
+      LOGGER.debug "data#{i}.dat removed."
+    end
+  end
+ 
+  def self.test_plot_lines
+    plot_lines("/tmp/result.svg" , "name of title", "x-values", "y-values", ["name", "test", "bla"], [[20,60,80], [10,25,70,95], [12,78,99]], [[15,50,90],[20,40,50,70],[34,89,89]],[true,false,true])
+  end
+ 
+  private
+  # float check
+  def self.numeric?(object) 
+   true if Float(object) rescue false
+  end
+end
+

data/lib/plot_points.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/ruby1.8
+# svg_roc_plot method - svg_roc_plot_method.rb
+#       
+# Copyright 2010 vorgrimmler <dv(a_t)fdm.uni-freiburg.de>
+# This ruby method (svg_roc_plot) exports input data(from true-positive-rate and false-positive-rate arrays) to a *.svg file using gnuplot. Depending on the amount of input data is possible to create 1 to n curves in one plot. 
+# Gnuplot is needed. Please install befor using svg_roc_plot. "sudo apt-get install gnuplot" (on debian systems).
+# Usage: See below.
+
+module RubyPlot
+
+  def self.plot_points(svg_path, title, x_lable, y_lable, names, x_values, y_values)
+    
+    LOGGER.debug names.inspect
+    LOGGER.debug x_values.inspect
+    LOGGER.debug y_values.inspect
+    
+    data = []
+    (0..x_values.size-1).each do |i|
+      data << y_values[i]
+      data << x_values[i]
+    end
+    
+    #Main
+    STDOUT.sync = true
+    # -----------------------------------------------------
+    # checking input
+    # -----------------------------------------------------
+    # check parameters
+    status=false
+    LOGGER.debug "#{names.length} algs entered"
+    
+    #LOGGER.debug names.inspect
+    #LOGGER.debug data.inspect
+    
+    if names.length != data.length/2
+        status=true
+    end
+    
+    if status
+      raise "Usage: svg_roc_plot (svg_path(?), title(string), x-lable(string), y-lable(sting), algorithms(array), true_pos_data1(array), false_pos_data1(array), ...,  true_pos_data_n(array), false_pos_data_n(array))\n"+
+            "       Only pairs of data are allowed but at least one.\n"+
+            "       Each data array has to provide one float/int number from 0 to 100 per entry."
+    end
+    
+    # gnuplot check
+    gnuplot=`which gnuplot | grep -o gnuplot`
+    if gnuplot == "gnuplot\n"
+      LOGGER.debug "Gnuplot is already installed."
+    else
+      raise "Please install gnuplot.\n"+
+            "sudo apt-get install gnuplot"
+    end
+    
+    dat_number=0
+    
+    output_dat_arr = Array.new
+    
+    
+    # -----------------------------------------------------
+    # create *.dat files of imported data for gnuplot
+    # -----------------------------------------------------
+    # write true/false arrays to one array
+    for i in 0..names.length-1#/2-1
+      true_pos_arr = data[i*2]
+      false_pos_arr = data[i*2+1]
+      #check length of input files
+      if true_pos_arr.length == false_pos_arr.length
+        #LOGGER.debug "Same length!"
+        for j in 0..true_pos_arr.length-1
+          #check if array entries are float format and between 0.0 and 100.0
+          #if numeric?(true_pos_arr[j].to_s.tr(',', '.')) && true_pos_arr[j].to_s.tr(',', '.').to_f <= 100 && true_pos_arr[j].to_s.tr(',', '.').to_f >= 0
+          #  if  numeric?(false_pos_arr[j].to_s.tr(',', '.')) && false_pos_arr[j].to_s.tr(',', '.').to_f <= 100 && false_pos_arr[j].to_s.tr(',', '.').to_f >= 0
+              output_dat_arr[j] = "#{true_pos_arr[j]} #{false_pos_arr[j]}"
+          #  else
+          #    raise "The data of #{names[i]}  has not the right formatin at position #{j}\n"+
+          #          "The right format is one float/int from 0 to 100 each line (e.g. '0'; '23,34'; '65.87' or '99')"
+          #  end
+          #else
+          #  raise "The data of #{names[i]}  has not the right formatin at position #{j}+\n"
+          #         "The right format is one float/int from 0 to 100 each line (e.g. '0'; '23,34'; '65.87' or '99')"
+          #end
+        end
+        #-----------------------------------------------------
+        #write *.dat files
+        #-----------------------------------------------------
+        #write output_dat_arr content in new *.dat file
+        File.open( "data#{i}.dat", "w" ) do |the_file|
+            the_file.puts output_dat_arr
+        end
+        LOGGER.debug "data#{i}.dat created."
+        output_dat_arr.clear
+            
+      else
+        raise "Data pair of #{names[i]} have no the same number of elements."
+      end
+    end
+    
+    # -----------------------------------------------------
+    # create *.plt file for gnuplot
+    # -----------------------------------------------------
+    # 
+    output_plt_arr = Array.new
+    output_plt_arr.push "# Specifies encoding and output format"
+    output_plt_arr.push "set encoding default"
+    #output_plt_arr.push "set terminal svg"
+    output_plt_arr.push 'set terminal svg size 800,600 dynamic enhanced fname "Arial" fsize 12 butt'
+    output_plt_arr.push "set output '#{svg_path}'"
+    output_plt_arr.push ""
+    output_plt_arr.push "# Specifies the range of the axes and appearance"
+    
+    #output_plt_arr.push "set xrange [0:100]"
+    #output_plt_arr.push "set yrange [0:100]"
+    output_plt_arr.push "set grid lw 0.5"
+    output_plt_arr.push "set title \"#{title}\""
+    output_plt_arr.push "set key below"
+    output_plt_arr.push "set xlabel \"#{x_lable}\""
+    output_plt_arr.push "set ylabel \"#{y_lable}\""
+    #output_plt_arr.push "set arrow to 1,1 nohead"
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    output_plt_arr.push "# Draws the plot and specifies its appearance ..."
+    
+    output_plt_arr.push "plot \\"#'random_0.dat' using 1:2 title 'random' with lines lw 1, \\"
+    i = 0
+    for i in 0..names.length-1
+      if i == names.length-1
+        output_plt_arr.push " 'data#{i}.dat'  using 2:1 title '#{names[i]}' with points"
+      else
+        output_plt_arr.push " 'data#{i}.dat'  using 2:1 title '#{names[i]}' with points, \\"
+      end
+    end
+    output_plt_arr.push ""
+    output_plt_arr.push ""
+    
+    
+    #output_plt_arr << "plot f(x)"
+    
+    # -----------------------------------------------------
+    # write *.plt files
+    # -----------------------------------------------------
+    # write output_dat_arr content in new *.dat file
+    File.open( "config.plt", "w" ) do |the_file|
+      the_file.puts output_plt_arr
+    end
+    LOGGER.debug "config.plt created, running gnuplot"
+    
+    # start gnuplot with created *.plt file
+    cmd = "gnuplot config.plt 2>&1"
+    response = ""
+    IO.popen(cmd) do |f| 
+      while line = f.gets
+        response += line
+      end
+    end
+    raise "gnuplot failes (cmd: "+cmd.to_s+", out: "+response.to_s+")" unless $?==0
+    
+    LOGGER.debug "#{svg_path} created. "
+    
+    # -----------------------------------------------------
+    # remove *.plt and *.dat files
+    # -----------------------------------------------------
+    `rm config.plt`
+    LOGGER.debug "config.plt removed."
+    for i in 0..names.length-1
+      `rm data#{i}.dat`
+      LOGGER.debug "data#{i}.dat removed."
+    end
+  end
+ 
+  def self.test_plot_points
+    plot_points("/tmp/result.svg" , "name of title", "x-values", "y-values", ["this-one-has-a-very-very-very-long-name", "test" ], [[0.20,0.60,0.80], [0.10,0.25,0.70,0.95]], [[0.15,0.50,0.90],[0.20,0.40,0.50,0.70]])
+  end
+ 
+  private
+  # float check
+  def self.numeric?(object) 
+   true if Float(object) rescue false
+  end
+end
+

data/lib/ruby-plot.rb

@@ -0,0 +1,16 @@
+require 'rubygems' 
+require 'logger'
+require 'gnuplot'
+
+unless(defined? LOGGER)
+  LOGGER = Logger.new(STDOUT)
+  LOGGER.datetime_format = "%Y-%m-%d %H:%M:%S "
+end
+
+require "plot_bars.rb"
+require "plot_lines.rb"
+require "plot_points.rb"
+
+#RubyPlot::test_plot_lines
+#RubyPlot::test_plot_bars
+#RubyPlot::test_plot_points

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-plot
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- David Vorgrimmler
+- "Martin G\xC3\xBCtlein"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-07 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gnuplot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: vorgrimmlerdavid@gmx.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- lib/plot_bars.rb
+- lib/plot_lines.rb
+- lib/plot_points.rb
+- lib/ruby-plot.rb
+has_rdoc: true
+homepage: http://github.com/davor/ruby-plot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: gnuplot wrapper for ruby, especially for plotting roc curves into svg files
+test_files: []
+