org-plot.el 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
  1. ;;; org-plot.el --- Support for Plotting from Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2008-2020 Free Software Foundation, Inc.
  3. ;;
  4. ;; Author: Eric Schulte <schulte dot eric at gmail dot com>
  5. ;; Maintainer: TEC <tecosaur@gmail.com>
  6. ;; Keywords: tables, plotting
  7. ;; Homepage: https://orgmode.org
  8. ;;
  9. ;; This file is part of GNU Emacs.
  10. ;;
  11. ;; GNU Emacs is free software: you can redistribute it and/or modify
  12. ;; it under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation, either version 3 of the License, or
  14. ;; (at your option) any later version.
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. ;; GNU General Public License for more details.
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  21. ;;; Commentary:
  22. ;; Borrows ideas and a couple of lines of code from org-exp.el.
  23. ;; Thanks to the Org mailing list for testing and implementation and
  24. ;; feature suggestions
  25. ;;; Code:
  26. (require 'cl-lib)
  27. (require 'org)
  28. (require 'org-table)
  29. (declare-function gnuplot-delchar-or-maybe-eof "ext:gnuplot" (arg))
  30. (declare-function gnuplot-mode "ext:gnuplot" ())
  31. (declare-function gnuplot-send-buffer-to-gnuplot "ext:gnuplot" ())
  32. (defvar org-plot/gnuplot-default-options
  33. '((:plot-type . 2d)
  34. (:with . lines)
  35. (:ind . 0))
  36. "Default options to gnuplot used by `org-plot/gnuplot'.")
  37. (defvar org-plot-timestamp-fmt nil)
  38. (defun org-plot/add-options-to-plist (p options)
  39. "Parse an OPTIONS line and set values in the property list P.
  40. Returns the resulting property list."
  41. (when options
  42. (let ((op '(("type" . :plot-type)
  43. ("script" . :script)
  44. ("line" . :line)
  45. ("set" . :set)
  46. ("title" . :title)
  47. ("ind" . :ind)
  48. ("deps" . :deps)
  49. ("with" . :with)
  50. ("file" . :file)
  51. ("labels" . :labels)
  52. ("map" . :map)
  53. ("timeind" . :timeind)
  54. ("timefmt" . :timefmt)
  55. ("min" . :ymin)
  56. ("max" . :ymax)
  57. ("ymin" . :ymin)
  58. ("xmax" . :xmax)
  59. ("ticks" . :ticks)
  60. ("trans" . :transpose)
  61. ("transpose" . :transpose)))
  62. (multiples '("set" "line"))
  63. (regexp ":\\([\"][^\"]+?[\"]\\|[(][^)]+?[)]\\|[^ \t\n\r;,.]*\\)")
  64. (start 0))
  65. (dolist (o op)
  66. (if (member (car o) multiples) ;; keys with multiple values
  67. (while (string-match
  68. (concat (regexp-quote (car o)) regexp)
  69. options start)
  70. (setq start (match-end 0))
  71. (setq p (plist-put p (cdr o)
  72. (cons (car (read-from-string
  73. (match-string 1 options)))
  74. (plist-get p (cdr o)))))
  75. p)
  76. (if (string-match (concat (regexp-quote (car o)) regexp)
  77. options)
  78. (setq p (plist-put p (cdr o)
  79. (car (read-from-string
  80. (match-string 1 options))))))))))
  81. p)
  82. (defun org-plot/goto-nearest-table ()
  83. "Move the point forward to the beginning of nearest table.
  84. Return value is the point at the beginning of the table."
  85. (interactive) (move-beginning-of-line 1)
  86. (while (not (or (org-at-table-p) (< 0 (forward-line 1)))))
  87. (goto-char (org-table-begin)))
  88. (defun org-plot/collect-options (&optional params)
  89. "Collect options from an org-plot `#+Plot:' line.
  90. Accepts an optional property list PARAMS, to which the options
  91. will be added. Returns the resulting property list."
  92. (interactive)
  93. (let ((line (thing-at-point 'line)))
  94. (if (string-match "#\\+PLOT: +\\(.*\\)$" line)
  95. (org-plot/add-options-to-plist params (match-string 1 line))
  96. params)))
  97. (defun org-plot-quote-timestamp-field (s)
  98. "Convert field S from timestamp to Unix time and export to gnuplot."
  99. (format-time-string org-plot-timestamp-fmt (org-time-string-to-time s)))
  100. (defun org-plot-quote-tsv-field (s)
  101. "Quote field S for export to gnuplot."
  102. (if (string-match org-table-number-regexp s) s
  103. (if (string-match org-ts-regexp3 s)
  104. (org-plot-quote-timestamp-field s)
  105. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\""))))
  106. (defun org-plot/gnuplot-to-data (table data-file params)
  107. "Export TABLE to DATA-FILE in a format readable by gnuplot.
  108. Pass PARAMS through to `orgtbl-to-generic' when exporting TABLE."
  109. (with-temp-file
  110. data-file
  111. (setq-local org-plot-timestamp-fmt (or
  112. (plist-get params :timefmt)
  113. "%Y-%m-%d-%H:%M:%S"))
  114. (insert (orgtbl-to-generic
  115. table
  116. (org-combine-plists
  117. '(:sep "\t" :fmt org-plot-quote-tsv-field)
  118. params))))
  119. nil)
  120. (defun org-plot/gnuplot-to-grid-data (table data-file params)
  121. "Export the data in TABLE to DATA-FILE for gnuplot.
  122. This means in a format appropriate for grid plotting by gnuplot.
  123. PARAMS specifies which columns of TABLE should be plotted as independent
  124. and dependent variables."
  125. (interactive)
  126. (let* ((ind (- (plist-get params :ind) 1))
  127. (deps (if (plist-member params :deps)
  128. (mapcar (lambda (val) (- val 1)) (plist-get params :deps))
  129. (let (collector)
  130. (dotimes (col (length (nth 0 table)))
  131. (setf collector (cons col collector)))
  132. collector)))
  133. (counter 0)
  134. row-vals)
  135. (when (>= ind 0) ;; collect values of ind col
  136. (setf row-vals (mapcar (lambda (row) (setf counter (+ 1 counter))
  137. (cons counter (nth ind row)))
  138. table)))
  139. (when (or deps (>= ind 0)) ;; remove non-plotting columns
  140. (setf deps (delq ind deps))
  141. (setf table (mapcar (lambda (row)
  142. (dotimes (col (length row))
  143. (unless (memq col deps)
  144. (setf (nth col row) nil)))
  145. (delq nil row))
  146. table)))
  147. ;; write table to gnuplot grid datafile format
  148. (with-temp-file data-file
  149. (let ((num-rows (length table)) (num-cols (length (nth 0 table)))
  150. (gnuplot-row (lambda (col row value)
  151. (setf col (+ 1 col)) (setf row (+ 1 row))
  152. (format "%f %f %f\n%f %f %f\n"
  153. col (- row 0.5) value ;; lower edge
  154. col (+ row 0.5) value))) ;; upper edge
  155. front-edge back-edge)
  156. (dotimes (col num-cols)
  157. (dotimes (row num-rows)
  158. (setf back-edge
  159. (concat back-edge
  160. (funcall gnuplot-row (- col 1) row
  161. (string-to-number (nth col (nth row table))))))
  162. (setf front-edge
  163. (concat front-edge
  164. (funcall gnuplot-row col row
  165. (string-to-number (nth col (nth row table)))))))
  166. ;; only insert once per row
  167. (insert back-edge) (insert "\n") ;; back edge
  168. (insert front-edge) (insert "\n") ;; front edge
  169. (setf back-edge "") (setf front-edge ""))))
  170. row-vals))
  171. (defun org--plot/values-stats (nums &optional hard-min hard-max)
  172. "From a list of NUMS return a plist containing some rudamentry statistics on the
  173. values, namely regarding the range."
  174. (let* ((minimum (or hard-min (apply #'min nums)))
  175. (maximum (or hard-max (apply #'max nums)))
  176. (range (- maximum minimum))
  177. (rangeOrder (ceiling (- 1 (log10 range))))
  178. (range-factor (expt 10 rangeOrder))
  179. (nice-min (/ (float (floor (* minimum range-factor))) range-factor))
  180. (nice-max (/ (float (ceiling (* maximum range-factor))) range-factor)))
  181. `(:min ,minimum :max ,maximum :range ,range
  182. :range-factor ,range-factor
  183. :nice-min ,nice-min :nice-max ,nice-max :nice-range ,(- nice-max nice-min))))
  184. (defun org--plot/sensible-tick-num (table &optional hard-min hard-max)
  185. "From a the values in a TABLE of data, attempt to guess an appropriate number of ticks."
  186. (let* ((row-data
  187. (mapcar (lambda (row) (org--plot/values-stats
  188. (mapcar #'string-to-number (cdr row))
  189. hard-min
  190. hard-max)) table))
  191. (row-normalised-ranges (mapcar (lambda (r-data)
  192. (let ((val (round (*
  193. (plist-get r-data :range-factor)
  194. (plist-get r-data :nice-range)))))
  195. (if (= (% val 10) 0) (/ val 10) val)))
  196. row-data))
  197. (range-prime-decomposition (mapcar #'org--plot/prime-factors row-normalised-ranges))
  198. (weighted-factors (sort (apply #'org--plot/merge-alists #'+ 0
  199. (mapcar (lambda (factors) (org--plot/item-frequencies factors t))
  200. range-prime-decomposition))
  201. (lambda (a b) (> (cdr a) (cdr b))))))
  202. (apply #'* (org--plot/nice-frequency-pick weighted-factors))))
  203. (defun org--plot/nice-frequency-pick (frequencies)
  204. "From a list of frequences, try to sensibly pick a sample of the most frequent."
  205. ;; TODO this mosly works decently, but counld do with some tweaking to work more consistently.
  206. (case (length frequencies)
  207. (1 (list (car (nth 0 frequencies))))
  208. (2 (if (<= 3 (/ (cdr (nth 0 frequencies))
  209. (cdr (nth 1 frequencies))))
  210. (make-list 2
  211. (car (nth 0 frequencies)))
  212. (list (car (nth 0 frequencies))
  213. (car (nth 1 frequencies)))))
  214. (t
  215. (let* ((total-count (apply #'+ (mapcar #'cdr frequencies)))
  216. (n-freq (mapcar (lambda (freq) `(,(car freq) . ,(/ (float (cdr freq)) total-count))) frequencies))
  217. (f-pick (list (car (car n-freq))))
  218. (1-2-ratio (/ (cdr (nth 0 n-freq))
  219. (cdr (nth 1 n-freq))))
  220. (2-3-ratio (/ (cdr (nth 1 n-freq))
  221. (cdr (nth 2 n-freq))))
  222. (1-3-ratio (* 1-2-ratio 2-3-ratio))
  223. (1-val (car (nth 0 n-freq)))
  224. (2-val (car (nth 1 n-freq)))
  225. (3-val (car (nth 2 n-freq))))
  226. (when (> 1-2-ratio 4) (push 1-val f-pick))
  227. (when (and (< 1-2-ratio 2-val)
  228. (< (* (apply #'* f-pick) 2-val) 30))
  229. (push 2-val f-pick))
  230. (when (and (< 1-3-ratio 3-val)
  231. (< (* (apply #'* f-pick) 3-val) 30))
  232. (push 3-val f-pick))
  233. f-pick))))
  234. (defun org--plot/merge-alists (function default alist1 alist2 &rest alists)
  235. "Using FUNCTION, combine the elements of all given ALISTS. When an element is
  236. only present in one alist, DEFAULT is used as the second argument for the FUNCTION."
  237. (when (> (length alists) 0)
  238. (setq alist2 (apply #'org--plot/merge-alists function default alist2 alists)))
  239. (flet ((keys (alist) (mapcar #'car alist))
  240. (lookup (key alist) (or (cdr (assoc key alist)) default)))
  241. (loop with keys = (union (keys alist1) (keys alist2) :test 'equal)
  242. for k in keys collect
  243. (cons k (funcall function (lookup k alist1) (lookup k alist2))))))
  244. (defun org--plot/item-frequencies (values &optional normalise)
  245. "Return an alist indicating the frequency of values in VALUES list."
  246. (let ((normaliser (if normalise (float (length values)) 1)))
  247. (cl-loop for (n . m) in (seq-group-by #'identity values)
  248. collect (cons n (/ (length m) normaliser)))))
  249. (defun org--plot/prime-factors (value)
  250. "Return the prime decomposition of VALUE, e.g. for 12, '(3 2 2)"
  251. (let ((factors '(1)) (i 1))
  252. (while (/= 1 value)
  253. (setq i (1+ i))
  254. (when (eq 0 (% value i))
  255. (push i factors)
  256. (setq value (/ value i))
  257. (setq i (1- i))
  258. ))
  259. (subseq factors 0 -1)))
  260. (defcustom org-plot/gnuplot-script-preamble ""
  261. "String or function which provides content to be inserted into the GNUPlot
  262. script before the plot command. Not that this is in addition to, not instead of
  263. other content generated in `org-plot/gnuplot-script'.
  264. If a function, it is called with the plot type as the argument."
  265. :group 'org-plot
  266. :type '(choice string function))
  267. (defcustom org-plot/preset-plot-types
  268. '((2d :plot-cmd "plot"
  269. :check-ind-type t
  270. :plot-func
  271. (lambda (_table data-file num-cols params plot-str)
  272. (let* ((type (plist-get params :plot-type))
  273. (with (if (eq type 'grid) 'pm3d (plist-get params :with)))
  274. (ind (plist-get params :ind))
  275. (deps (if (plist-member params :deps) (plist-get params :deps)))
  276. (text-ind (plist-get params :textind))
  277. (col-labels (plist-get params :labels))
  278. res)
  279. (dotimes (col num-cols res)
  280. (unless (and (eq type '2d)
  281. (or (and ind (equal (1+ col) ind))
  282. (and deps (not (member (1+ col) deps)))))
  283. (setf res
  284. (cons
  285. (format plot-str data-file
  286. (or (and ind (> ind 0)
  287. (not text-ind)
  288. (format "%d:" ind)) "")
  289. (1+ col)
  290. (if text-ind (format ":xticlabel(%d)" ind) "")
  291. with
  292. (or (nth col col-labels)
  293. (format "%d" (1+ col))))
  294. res)))))))
  295. (3d :plot-cmd "splot"
  296. :plot-pre (lambda (_table _data-file _num-cols params _plot-str)
  297. (if (plist-get params :map) "set map"))
  298. :plot-func
  299. (lambda (_table data-file _num-cols params _plot-str)
  300. (let* ((type (plist-get params :plot-type))
  301. (with (if (eq type 'grid) 'pm3d (plist-get params :with))))
  302. (list (format "'%s' matrix with %s title ''"
  303. data-file with)))))
  304. (grid :plot-cmd "splot"
  305. :plot-pre (lambda (_table _data-file _num-cols params _plot-str)
  306. (if (plist-get params :map) "set pm3d map" "set map"))
  307. :data-dump (lambda (table data-file params _num-cols)
  308. (let ((y-labels (org-plot/gnuplot-to-grid-data
  309. table data-file params)))
  310. (when y-labels (plist-put params :ylabels y-labels))))
  311. :plot-func
  312. (lambda (table data-file _num-cols params _plot-str)
  313. (let* ((type (plist-get params :plot-type))
  314. (with (if (eq type 'grid) 'pm3d (plist-get params :with))))
  315. (list (format "'%s' with %s title ''"
  316. data-file with)))))
  317. (radar :plot-func
  318. (lambda (table _data-file _num-cols params plot-str)
  319. (list (org--plot/radar table params)))))
  320. "List of plists describing the avalible plot types.
  321. The car is the type name, and the property :plot-func must be set.
  322. The value of :plot-func is a lambda which yields plot-lines
  323. (a list of strings) as the cdr.
  324. All lambda functions have the parameters of `org-plot/gnuplot-script' and PLOT-STR passed to them.
  325. i.e. they are called with the following signature: (TABLE DATA-FILE NUM-COLS PARAMS PLOT-STR)
  326. Potentially useful parameters in PARAMS include:
  327. :set :line :map :title :file :ind :timeind :timefmt :textind
  328. :deps :labels :xlabels :ylabels :xmin :xmax :ymin :ymax :ticks
  329. In addition to :plot-func, the following optional properties may be set.
  330. - :plot-cmd - A gnuplot command appended to each plot-line.
  331. Accepts string or nil. Default value: nil.
  332. - :check-ind-type - Whether the types of ind values should be checked.
  333. Accepts boolean.
  334. - :plot-str - the formula string passed to :plot-func as PLOT-STR
  335. Accepts string. Default value: \"'%s' using %s%d%s with %s title '%s'\"
  336. - :data-dump - Function to dump the table to a datafile for ease of use.
  337. Accepts lambda function. Default lambda body: (org-plot/gnuplot-to-data table data-file params)
  338. - :plot-pre - Gnuplot code to be inserted early into the script, just after term and output have been set.
  339. Accepts string, nil, or lambda function which returns string or nil. Defaults to nil.
  340. "
  341. :group 'org-plot
  342. :type '(alist :value-type (symbol group)))
  343. (defvar org--plot/radar-template
  344. "### spider plot/chart with gnuplot
  345. # also known as: radar chart, web chart, star chart, cobweb chart,
  346. # radar plot, web plot, star plot, cobweb plot, etc. ...
  347. set datafile separator ' '
  348. set size square
  349. unset tics
  350. set angles degree
  351. set key bmargin center horizontal
  352. unset border
  353. # Load data and settup
  354. load \"%s\"
  355. # General settings
  356. DataColCount = words($Data[1])-1
  357. AxesCount = |$Data|-HeaderLines
  358. AngleOffset = 90
  359. Max = 1
  360. d=0.1*Max
  361. Direction = -1 # counterclockwise=1, clockwise = -1
  362. # Tic settings
  363. TicCount = %s
  364. TicOffset = 0.1
  365. TicValue(axis,i) = real(i)*(word($Settings[axis],3)-word($Settings[axis],2)) \\
  366. / word($Settings[axis],4)+word($Settings[axis],2)
  367. TicLabelPosX(axis,i) = PosX(axis,i/TicCount) + PosY(axis, TicOffset)
  368. TicLabelPosY(axis,i) = PosY(axis,i/TicCount) - PosX(axis, TicOffset)
  369. TicLen = 0.03
  370. TicdX(axis,i) = 0.5*TicLen*cos(alpha(axis)-90)
  371. TicdY(axis,i) = 0.5*TicLen*sin(alpha(axis)-90)
  372. # Label
  373. LabOffset = 0.10
  374. LabX(axis) = PosX(axis+1,Max+2*d) + PosY(axis, LabOffset)
  375. LabY(axis) = PosY($0+1,Max+2*d)
  376. # Functions
  377. alpha(axis) = (axis-1)*Direction*360.0/AxesCount+AngleOffset
  378. PosX(axis,R) = R*cos(alpha(axis))
  379. PosY(axis,R) = R*sin(alpha(axis))
  380. Scale(axis,value) = real(value-word($Settings[axis],2))/(word($Settings[axis],3)-word($Settings[axis],2))
  381. # Spider settings
  382. set style arrow 1 dt 1 lw 1.0 @fgal head filled size 0.06,25 # style for axes
  383. set style arrow 2 dt 2 lw 0.5 @fgal nohead # style for weblines
  384. set style arrow 3 dt 1 lw 1 @fgal nohead # style for axis tics
  385. set samples AxesCount
  386. set isosamples TicCount
  387. set urange[1:AxesCount]
  388. set vrange[1:TicCount]
  389. set style fill transparent solid 0.2
  390. set xrange[-Max-4*d:Max+4*d]
  391. set yrange[-Max-4*d:Max+4*d]
  392. plot \\
  393. '+' u (0):(0):(PosX($0,Max+d)):(PosY($0,Max+d)) w vec as 1 not, \\
  394. $Data u (LabX($0)): \\
  395. (LabY($0)):1 every ::HeaderLines w labels center enhanced @fgt not, \\
  396. for [i=1:DataColCount] $Data u (PosX($0+1,Scale($0+1,column(i+1)))): \\
  397. (PosY($0+1,Scale($0+1,column(i+1)))) every ::HeaderLines w filledcurves lt i title word($Data[1],i+1), \\
  398. %s
  399. # '++' u (PosX($1,$2/TicCount)-TicdX($1,$2/TicCount)): \\
  400. # (PosY($1,$2/TicCount)-TicdY($1,$2/TicCount)): \\
  401. # (2*TicdX($1,$2/TicCount)):(2*TicdY($1,$2/TicCount)) \\
  402. # w vec as 3 not, \\
  403. ### end of code
  404. ")
  405. (defvar org--plot/radar-ticks
  406. " '++' u (PosX($1,$2/TicCount)):(PosY($1,$2/TicCount)): \\
  407. (PosX($1+1,$2/TicCount)-PosX($1,$2/TicCount)): \\
  408. (PosY($1+1,$2/TicCount)-PosY($1,$2/TicCount)) w vec as 2 not, \\
  409. '++' u (TicLabelPosX(%s,$2)):(TicLabelPosY(%s,$2)): \\
  410. (sprintf('%%g',TicValue(%s,$2))) w labels font ',8' @fgat not")
  411. (defvar org--plot/radar-setup-template
  412. "# Data
  413. $Data <<HEREHAVESOMEDATA
  414. %s
  415. HEREHAVESOMEDATA
  416. HeaderLines = 1
  417. # Settings for scale and offset adjustments
  418. # axis min max tics axisLabelXoff axisLabelYoff
  419. $Settings <<EOD
  420. %s
  421. EOD
  422. ")
  423. (defun org--plot/radar (table params)
  424. (let* ((data
  425. (concat "\"" (s-join "\" \"" (plist-get params :labels)) "\""
  426. "\n"
  427. (s-join "\n"
  428. (mapcar (lambda (row)
  429. (format
  430. "\"%s\" %s"
  431. (car row)
  432. (s-join " " (cdr row))))
  433. table))))
  434. (ticks (or (plist-get params :ticks)
  435. (org--plot/sensible-tick-num table
  436. (plist-get params :ymin)
  437. (plist-get params :ymax))))
  438. (settings
  439. (s-join "\n"
  440. (mapcar (lambda (row)
  441. (let ((data (org--plot/values-stats
  442. (mapcar #'string-to-number (cdr row)))))
  443. (format
  444. "\"%s\" %s %s %s"
  445. (car row)
  446. (or (plist-get params :ymin)
  447. (plist-get data :nice-min))
  448. (or (plist-get params :ymax)
  449. (plist-get data :nice-max))
  450. (if (eq ticks 0) 2 ticks)
  451. )))
  452. table)))
  453. (setup-file (make-temp-file "org-plot-setup")))
  454. (f-write-text (format org--plot/radar-setup-template data settings)
  455. 'utf-8 setup-file)
  456. (format org--plot/radar-template
  457. setup-file
  458. (if (eq ticks 0) 2 ticks)
  459. (if (eq ticks 0) ""
  460. (apply #'format org--plot/radar-ticks
  461. (make-list 3 (if (and (plist-get params :ymin)
  462. (plist-get params :ymax))
  463. ;; FIXME multi-drawing of tick labels with "1"
  464. "1" "$1")))))))
  465. (defcustom org-plot/gnuplot-term-extra ""
  466. "String or function which provides the extra term options.
  467. E.g. a value of \"size 1050,650\" would cause
  468. \"set term ... size 1050,650\" to be used.
  469. If a function, it is called with the plot type as the argument."
  470. :group 'org-plot
  471. :type '(choice string function))
  472. (defun org-plot/gnuplot-script (table data-file num-cols params &optional preface)
  473. "Write a gnuplot script to DATA-FILE respecting the options set in PARAMS.
  474. NUM-COLS controls the number of columns plotted in a 2-d plot.
  475. Optional argument PREFACE returns only option parameters in a
  476. manner suitable for prepending to a user-specified script."
  477. (let* ((type-name (plist-get params :plot-type))
  478. (type (cdr (assoc type-name org-plot/preset-plot-types))))
  479. (unless type
  480. (user-error "Org-plot type `%s' is undefined." type-name))
  481. (let* ((sets (plist-get params :set))
  482. (lines (plist-get params :line))
  483. (map (plist-get params :map))
  484. (title (plist-get params :title))
  485. (file (plist-get params :file))
  486. (ind (plist-get params :ind))
  487. (time-ind (plist-get params :timeind))
  488. (timefmt (plist-get params :timefmt))
  489. (text-ind (plist-get params :textind))
  490. (deps (if (plist-member params :deps) (plist-get params :deps)))
  491. (col-labels (plist-get params :labels))
  492. (x-labels (plist-get params :xlabels))
  493. (y-labels (plist-get params :ylabels))
  494. (plot-str (or (plist-get type :plot-str)
  495. "'%s' using %s%d%s with %s title '%s'"))
  496. (plot-cmd (plist-get type :plot-cmd))
  497. (plot-pre (plist-get type :plot-pre))
  498. (script "reset")
  499. ;; ats = add-to-script
  500. (ats (lambda (line) (when line (setf script (concat script "\n" line)))))
  501. plot-lines)
  502. ;; handle output file, background, and size
  503. (funcall ats (format "set term %s %s"
  504. (if file (file-name-extension file) "GNUTERM")
  505. (if (stringp org-plot/gnuplot-term-extra)
  506. org-plot/gnuplot-term-extra
  507. (funcall org-plot/gnuplot-term-extra type))))
  508. (when file ; output file
  509. (funcall ats (format "set output '%s'" file)))
  510. (when plot-pre
  511. (funcall ats (funcall plot-pre table data-file num-cols params plot-str)))
  512. (funcall ats
  513. (if (stringp org-plot/gnuplot-script-preamble)
  514. org-plot/gnuplot-script-preamble
  515. (funcall org-plot/gnuplot-script-preamble type)))
  516. (when title (funcall ats (format "set title '%s'" title))) ; title
  517. (mapc ats lines) ; line
  518. (dolist (el sets) (funcall ats (format "set %s" el))) ; set
  519. ;; Unless specified otherwise, values are TAB separated.
  520. (unless (string-match-p "^set datafile separator" script)
  521. (funcall ats "set datafile separator \"\\t\""))
  522. (when x-labels ; x labels (xtics)
  523. (funcall ats
  524. (format "set xtics (%s)"
  525. (mapconcat (lambda (pair)
  526. (format "\"%s\" %d" (cdr pair) (car pair)))
  527. x-labels ", "))))
  528. (when y-labels ; y labels (ytics)
  529. (funcall ats
  530. (format "set ytics (%s)"
  531. (mapconcat (lambda (pair)
  532. (format "\"%s\" %d" (cdr pair) (car pair)))
  533. y-labels ", "))))
  534. (when time-ind ; timestamp index
  535. (funcall ats "set xdata time")
  536. (funcall ats (concat "set timefmt \""
  537. (or timefmt ; timefmt passed to gnuplot
  538. "%Y-%m-%d-%H:%M:%S") "\"")))
  539. (unless preface
  540. (let ((type-func (plist-get type :plot-func)))
  541. (when type-func
  542. (setq plot-lines
  543. (funcall type-func table data-file num-cols params plot-str))))
  544. (funcall ats
  545. (concat plot-cmd
  546. (when plot-cmd " ")
  547. (mapconcat #'identity
  548. (reverse plot-lines)
  549. ",\\\n "))))
  550. script)))
  551. ;;-----------------------------------------------------------------------------
  552. ;; facade functions
  553. ;;;###autoload
  554. (defun org-plot/gnuplot (&optional params)
  555. "Plot table using gnuplot. Gnuplot options can be specified with PARAMS.
  556. If not given options will be taken from the +PLOT
  557. line directly before or after the table."
  558. (interactive)
  559. (require 'gnuplot)
  560. (save-window-excursion
  561. (delete-other-windows)
  562. (when (get-buffer "*gnuplot*") ; reset *gnuplot* if it already running
  563. (with-current-buffer "*gnuplot*"
  564. (goto-char (point-max))))
  565. (org-plot/goto-nearest-table)
  566. ;; Set default options.
  567. (dolist (pair org-plot/gnuplot-default-options)
  568. (unless (plist-member params (car pair))
  569. (setf params (plist-put params (car pair) (cdr pair)))))
  570. ;; Collect options.
  571. (save-excursion (while (and (equal 0 (forward-line -1))
  572. (looking-at "[[:space:]]*#\\+"))
  573. (setf params (org-plot/collect-options params))))
  574. ;; collect table and table information
  575. (let* ((data-file (make-temp-file "org-plot"))
  576. (table (let ((tbl (org-table-to-lisp)))
  577. (when (pcase (plist-get params :transpose)
  578. ('y t)
  579. ('yes t)
  580. ('t t))
  581. (if (not (memq 'hline tbl))
  582. (setq tbl (apply #'cl-mapcar #'list tbl))
  583. ;; When present, remove hlines as they can't (currentily) be easily transposed.
  584. (setq tbl (apply #'cl-mapcar #'list
  585. (remove 'hline tbl)))
  586. (push 'hline (cdr tbl))))
  587. tbl))
  588. (num-cols (length (if (eq (nth 0 table) 'hline) (nth 1 table)
  589. (nth 0 table))))
  590. (type (assoc (plist-get params :plot-type)
  591. org-plot/preset-plot-types)))
  592. (unless type
  593. (user-error "Org-plot type `%s' is undefined." type-name))
  594. (run-with-idle-timer 0.1 nil #'delete-file data-file)
  595. (when (eq (cadr table) 'hline)
  596. (setf params
  597. (plist-put params :labels (car table))) ; headers to labels
  598. (setf table (delq 'hline (cdr table)))) ; clean non-data from table
  599. ;; Collect options.
  600. (save-excursion (while (and (equal 0 (forward-line -1))
  601. (looking-at "[[:space:]]*#\\+"))
  602. (setf params (org-plot/collect-options params))))
  603. ;; Dump table to datafile
  604. (if-let ((dump-func (plist-get type :data-dump)))
  605. (funcall dump-func table data-file num-cols params)
  606. (org-plot/gnuplot-to-data table data-file params))
  607. ;; Check type of ind column (timestamp? text?)
  608. (when (plist-get params :check-ind-type)
  609. (let* ((ind (1- (plist-get params :ind)))
  610. (ind-column (mapcar (lambda (row) (nth ind row)) table)))
  611. (cond ((< ind 0) nil) ; ind is implicit
  612. ((cl-every (lambda (el)
  613. (string-match org-ts-regexp3 el))
  614. ind-column)
  615. (plist-put params :timeind t)) ; ind holds timestamps
  616. ((or (string= (plist-get params :with) "hist")
  617. (cl-notevery (lambda (el)
  618. (string-match org-table-number-regexp el))
  619. ind-column))
  620. (plist-put params :textind t))))) ; ind holds text
  621. ;; Write script.
  622. (with-temp-buffer
  623. (if (plist-get params :script) ; user script
  624. (progn (insert
  625. (org-plot/gnuplot-script table data-file num-cols params t))
  626. (insert "\n")
  627. (insert-file-contents (plist-get params :script))
  628. (goto-char (point-min))
  629. (while (re-search-forward "\\$datafile" nil t)
  630. (replace-match data-file nil nil)))
  631. (insert (org-plot/gnuplot-script table data-file num-cols params)))
  632. ;; Graph table.
  633. (gnuplot-mode)
  634. (gnuplot-send-buffer-to-gnuplot))
  635. ;; Cleanup.
  636. (bury-buffer (get-buffer "*gnuplot*")))))
  637. (provide 'org-plot)
  638. ;; Local variables:
  639. ;; generated-autoload-file: "org-loaddefs.el"
  640. ;; End:
  641. ;;; org-plot.el ends here