Create comma sep lists from list of plots

Author: devstopfix

README.md

@@ -101,7 +101,7 @@ by adding `gnuplot` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:gnuplot, "~> 0.19.73"}
+    {:gnuplot, "~> 0.19.86"}
   ]
 end
 ```

examples/atan_sin_dataset.exs

@@ -0,0 +1,41 @@
+defmodule AtanSin do
+  import Gnuplot
+
+  @moduledoc "http://gnuplot.sourceforge.net/demo/simple.7.gnu"
+
+  def png, do: Path.join("docs", "atan_sin_dataset.PNG")
+
+  def target,
+    do: [
+      [:set, :term, :png, :size, '512,256', :font, "/Library/Fonts/FiraCode-Medium.ttf", 12],
+      [:set, :output, png()]
+    ]
+
+  def commands,
+    do: [
+      [
+        :plot,
+        "-",
+        :with,
+        :lines,
+        :title,
+        "sin(x*20)*atan(x)"
+      ]
+    ]
+
+  def plot, do: plot(target() ++ commands(), [dataset()])
+
+  defp dataset do
+    Enum.map(ffor(-30, 20, 800), fn x -> [x, :math.sin(x * 20) * :math.atan(x)] end)
+  end
+
+  # defp dataset2 do
+  #   for x <- -30_000..20_000,
+  #       do: [x / 1000.0, :math.sin(x * 20 / 1000.0) * :math.atan(x / 1000.0)]
+  # end
+
+  defp ffor(min, max, step), do: for(x <- min..max, dx <- 0..step, do: x + dx / step)
+end
+
+# mix run examples/atan_sin_dataset.exs
+AtanSin.plot()

lib/gnuplot.ex

@@ -2,21 +2,36 @@ defmodule Gnuplot do
   @moduledoc """
   Interface to the Gnuplot graphing library.
 
-  Plot a sine wave:
+  Plot a sine function where Gnuplot generates the samples:
 
       Gnuplot.plot([
         ~w(set autoscale)a,
         ~w(set samples 800)a,
         [:plot, -30..20, 'sin(x*20)*atan(x)']
       ])
 
+  Plot a sine function where your program generates the data:
+
+      Gnuplot.plot([
+        [:plot, "-", :with, :lines :title, "sin(x*20)*atan(x)"]
+      ],
+      [
+        for x <- -30_000..20_000, do: [x / 1000.0 , :math.sin(x * 20 / 1000.0) * :math.atan(x / 1000.0) ]
+      ])
+
   """
 
   alias Gnuplot.Commands
   import Gnuplot.Dataset
 
   @doc """
-  Transmit commands and data streams to gnuplot.
+  Plot a function that has no dataset.
+  """
+  @spec plot(list(term())) :: {:ok, String.t()} | {:error, term()}
+  def plot(commands), do: plot(commands, [])
+
+  @doc """
+  Transmit commands and datasets to Gnuplot.
 
   ## Examples
 
@@ -45,32 +60,31 @@ defmodule Gnuplot do
   end
 
   @doc """
-  Plot a function that has no dataset.
+  Find the gnuplot executable.
   """
-  @spec plot(list(term())) :: {:ok, String.t()} | {:error, term()}
-  def plot(commands), do: plot(commands, [])
+  @spec gnuplot_bin() :: {:error, :gnuplot_missing} | {:ok, :file.name()}
+  def gnuplot_bin do
+    case :os.find_executable(String.to_charlist("gnuplot")) do
+      false -> {:error, :gnuplot_missing}
+      path -> {:ok, path}
+    end
+  end
 
-  @doc """
-  Build a comma separated list.
-  """
-  def list(a), do: %Commands.List{xs: [a]}
+  @doc "Build a comma separated list from a list of terms."
+  def list(xs) when is_list(xs), do: %Commands.List{xs: xs}
 
+  @doc "Build a comma separated list of two terms."
   def list(a, b), do: %Commands.List{xs: [a, b]}
 
+  @doc "Build a comma separated list of three terms."
   def list(a, b, c), do: %Commands.List{xs: [a, b, c]}
 
+  @doc "Build a comma separated list of four terms."
   def list(a, b, c, d), do: %Commands.List{xs: [a, b, c, d]}
 
+  @doc "Build a comma separated list of five terms."
   def list(a, b, c, d, e), do: %Commands.List{xs: [a, b, c, d, e]}
 
-  @doc """
-  Find the gnuplot executable.
-  """
-  @spec gnuplot_bin() :: {:error, :gnuplot_missing} | {:ok, :file.name()}
-  def gnuplot_bin do
-    case :os.find_executable(String.to_charlist("gnuplot")) do
-      false -> {:error, :gnuplot_missing}
-      path -> {:ok, path}
-    end
-  end
+  @doc "Build a comma separated list of six terms."
+  def list(a, b, c, d, e, f), do: %Commands.List{xs: [a, b, c, d, e, f]}
 end

lib/gnuplot/commands.ex

@@ -42,7 +42,10 @@ defmodule Gnuplot.Commands do
   end
 
   defmodule List do
-    @moduledoc "Comma separated lists"
+    @moduledoc """
+    Comma separated list.
+    Most lists are joined with whitespace, however the plot and splot commands require multiple plots to be comma separated.
+    """
     defstruct xs: []
   end
 

mix.exs

@@ -4,7 +4,7 @@ defmodule Gnuplot.MixProject do
   def project do
     [
       app: :gnuplot,
-      version: "0.19.73",
+      version: "0.19.86",
       elixir: "~> 1.6",
       start_permanent: Mix.env() == :prod,
       description: "Interface between Elixir and Gnuplot graphing library",
@@ -27,10 +27,10 @@ defmodule Gnuplot.MixProject do
 
   defp deps do
     [
-      {:credo, "~> 1.0.2", only: [:dev, :test], runtime: false},
-      {:dialyxir, "~> 1.0.0-rc.4", only: [:dev], runtime: false},
-      {:ex_doc, ">= 0.0.0", only: :dev},
-      {:mix_test_watch, "~> 0.8", only: :dev, runtime: false}
+      {:credo, "~> 1.0.4", only: [:dev, :test], runtime: false},
+      {:dialyxir, "~> 1.0.0-rc.5", only: [:dev], runtime: false},
+      {:ex_doc, ">= 0.19.0", only: :dev},
+      {:mix_test_watch, "~> 0.9", only: :dev, runtime: false}
     ]
   end
 

test/gnuplot_test.exs

@@ -42,6 +42,16 @@ defmodule GnuplotTest do
              input |> D.format_datasets() |> Enum.to_list()
   end
 
+  test "Comma separated lists of plots using arity 2" do
+    assert "plot a with lines,b with points" ==
+             C.format([[:plot, G.list([:a, :with, :lines], [:b, :with, :points])]])
+  end
+
+  test "Comma separated lists of plots using arity 1 and sublists" do
+    assert "plot a with lines,b with points" ==
+             C.format([[:plot, G.list([[:a, :with, :lines], [:b, :with, :points]])]])
+  end
+
   @tag gnuplot: true
   test "Gnuplot is installed" do
     assert {:ok, path} = G.gnuplot_bin()