2009-05-24 20:38:01 +00:00
|
|
|
;;; org-babel-R.el --- org-babel functions for R code evaluation
|
2009-03-25 21:42:57 +00:00
|
|
|
|
2009-03-29 22:09:06 +00:00
|
|
|
;; Copyright (C) 2009 Eric Schulte
|
2009-03-25 21:42:57 +00:00
|
|
|
|
2009-03-29 22:09:06 +00:00
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research, R, statistics
|
2009-03-25 21:42:57 +00:00
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
;; Version: 0.01
|
|
|
|
|
|
|
|
;;; License:
|
|
|
|
|
|
|
|
;; This program is free software; you can redistribute it and/or modify
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
;; the Free Software Foundation; either version 3, or (at your option)
|
|
|
|
;; any later version.
|
|
|
|
;;
|
|
|
|
;; This program is distributed in the hope that it will be useful,
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
;;
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
;; Org-Babel support for evaluating R code
|
2009-03-25 21:42:57 +00:00
|
|
|
|
|
|
|
;;; Code:
|
2009-05-24 20:38:01 +00:00
|
|
|
(require 'org-babel)
|
2009-03-25 21:42:57 +00:00
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
(org-babel-add-interpreter "R")
|
2009-03-25 21:42:57 +00:00
|
|
|
|
2009-06-15 22:25:46 +00:00
|
|
|
(add-to-list 'org-babel-tangle-langs '("R" "r"))
|
|
|
|
|
2009-07-08 04:13:07 +00:00
|
|
|
(defun org-babel-execute:R (body params)
|
2009-05-24 20:38:01 +00:00
|
|
|
"Execute a block of R code with org-babel. This function is
|
2009-07-16 20:21:07 +00:00
|
|
|
called by `org-babel-execute-src-block' via multiple-value-bind."
|
2009-03-29 22:09:06 +00:00
|
|
|
(message "executing R source code block...")
|
2009-03-25 21:42:57 +00:00
|
|
|
(save-window-excursion
|
2009-07-16 20:21:07 +00:00
|
|
|
(let ((full-body (concat
|
|
|
|
(mapconcat ;; define any variables
|
|
|
|
(lambda (pair)
|
|
|
|
(org-babel-R-assign-elisp (car pair) (cdr pair)))
|
|
|
|
vars "\n") "\n" body "\n"))
|
2009-07-19 05:07:07 +00:00
|
|
|
(session (org-babel-R-initiate-session session))
|
|
|
|
(colnames (cdr (assoc :colnames params))))
|
|
|
|
(org-babel-R-evaluate session full-body result-type colnames))))
|
2009-04-04 23:23:35 +00:00
|
|
|
|
2009-06-14 18:48:11 +00:00
|
|
|
(defun org-babel-prep-session:R (session params)
|
|
|
|
"Prepare SESSION according to the header arguments specified in PARAMS."
|
|
|
|
(let* ((session (org-babel-R-initiate-session session))
|
|
|
|
(vars (org-babel-ref-variables params)))
|
|
|
|
(mapc (lambda (pair) (org-babel-R-assign-elisp session (car pair) (cdr pair))) vars)))
|
|
|
|
|
|
|
|
;; helper functions
|
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
(defun org-babel-R-quote-tsv-field (s)
|
2009-04-04 23:23:35 +00:00
|
|
|
"Quote field S for export to R."
|
2009-05-22 14:57:35 +00:00
|
|
|
(if (stringp s)
|
|
|
|
(concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
|
|
|
|
(format "%S" s)))
|
2009-04-04 23:23:35 +00:00
|
|
|
|
2009-06-15 19:17:58 +00:00
|
|
|
(defun org-babel-R-assign-elisp (name value)
|
|
|
|
"Read the elisp VALUE into a variable named NAME."
|
|
|
|
(if (listp value)
|
|
|
|
(let ((transition-file (make-temp-file "org-babel-R-import")))
|
|
|
|
;; ensure VALUE has an orgtbl structure (depth of at least 2)
|
|
|
|
(unless (listp (car value)) (setq value (list value)))
|
|
|
|
(with-temp-file transition-file
|
|
|
|
(insert (orgtbl-to-tsv value '(:fmt org-babel-R-quote-tsv-field)))
|
|
|
|
(insert "\n"))
|
2009-07-19 05:07:07 +00:00
|
|
|
(format "%s <- read.table(\"%s\", header=%s, sep=\"\\t\", as.is=TRUE)"
|
|
|
|
name transition-file (if (eq (second value) 'hline) "TRUE" "FALSE")))
|
2009-06-15 19:17:58 +00:00
|
|
|
(format "%s <- %s" name (org-babel-R-quote-tsv-field value))))
|
2009-05-18 00:42:04 +00:00
|
|
|
|
2009-06-12 00:04:42 +00:00
|
|
|
(defun org-babel-R-initiate-session (session)
|
|
|
|
"If there is not a current R process then create one."
|
2009-06-15 18:49:06 +00:00
|
|
|
(unless (string= session "none")
|
|
|
|
(setq session (or session "*R*"))
|
|
|
|
(if (org-babel-comint-buffer-livep session)
|
|
|
|
session
|
2009-07-12 03:59:04 +00:00
|
|
|
(save-window-excursion
|
|
|
|
(R)
|
|
|
|
(rename-buffer (if (bufferp session) (buffer-name session)
|
|
|
|
(if (stringp session) session (buffer-name)))) (current-buffer)))))
|
2009-06-12 00:04:42 +00:00
|
|
|
|
|
|
|
(defvar org-babel-R-eoe-indicator "'org_babel_R_eoe'")
|
|
|
|
(defvar org-babel-R-eoe-output "[1] \"org_babel_R_eoe\"")
|
2009-06-15 18:49:06 +00:00
|
|
|
(defvar org-babel-R-wrapper-method "main <- function ()\n{\n%s\n}
|
2009-07-19 05:07:07 +00:00
|
|
|
write.table(main(), file=\"%s\", sep=\"\\t\", na=\"nil\",row.names=FALSE, col.names=%s, quote=FALSE)")
|
2009-06-12 00:04:42 +00:00
|
|
|
|
2009-07-19 05:07:07 +00:00
|
|
|
(defun org-babel-R-evaluate (buffer body result-type colnames)
|
2009-06-12 00:04:42 +00:00
|
|
|
"Pass BODY to the R process in BUFFER. If RESULT-TYPE equals
|
|
|
|
'output then return a list of the outputs of the statements in
|
|
|
|
BODY, if RESULT-TYPE equals 'value then return the value of the
|
2009-07-06 01:23:17 +00:00
|
|
|
last statement in BODY, as elisp."
|
2009-06-15 18:49:06 +00:00
|
|
|
(if (not session)
|
|
|
|
;; external process evaluation
|
|
|
|
(let ((in-tmp-file (make-temp-file "R-in-functional-results"))
|
|
|
|
(out-tmp-file (make-temp-file "R-out-functional-results")))
|
|
|
|
(case result-type
|
|
|
|
(output
|
|
|
|
(with-temp-file in-tmp-file (insert body))
|
2009-07-05 19:52:41 +00:00
|
|
|
(shell-command-to-string (format "R --slave --no-save < '%s' > '%s'"
|
2009-07-06 01:23:17 +00:00
|
|
|
in-tmp-file out-tmp-file))
|
|
|
|
(with-temp-buffer (insert-file-contents out-tmp-file) (buffer-string)))
|
2009-06-15 18:49:06 +00:00
|
|
|
(value
|
|
|
|
(with-temp-file in-tmp-file
|
2009-07-19 05:07:07 +00:00
|
|
|
(insert (format org-babel-R-wrapper-method
|
|
|
|
body out-tmp-file (if colnames "TRUE" "FALSE"))))
|
2009-07-06 01:23:17 +00:00
|
|
|
(shell-command (format "R --no-save < '%s'" in-tmp-file))
|
2009-07-19 05:07:07 +00:00
|
|
|
(org-babel-import-elisp-from-file out-tmp-file colnames))))
|
2009-06-15 18:49:06 +00:00
|
|
|
;; comint session evaluation
|
|
|
|
(org-babel-comint-in-buffer buffer
|
|
|
|
(let* ((tmp-file (make-temp-file "org-babel-R"))
|
|
|
|
(last-value-eval
|
2009-07-19 05:07:07 +00:00
|
|
|
(format "write.table(.Last.value, file=\"%s\", sep=\"\\t\", na=\"nil\",row.names=FALSE, col.names=%s, quote=FALSE)" tmp-file (if colnames "TRUE" "FALSE")))
|
2009-07-08 04:13:07 +00:00
|
|
|
(full-body (mapconcat #'org-babel-chomp
|
2009-07-05 19:52:41 +00:00
|
|
|
(list body last-value-eval org-babel-R-eoe-indicator) "\n"))
|
2009-06-15 18:49:06 +00:00
|
|
|
(raw (org-babel-comint-with-output buffer org-babel-R-eoe-output nil
|
2009-07-08 04:13:07 +00:00
|
|
|
(insert full-body) (inferior-ess-send-input)))
|
2009-07-05 19:52:41 +00:00
|
|
|
(results
|
|
|
|
(let ((broke nil))
|
|
|
|
(delete
|
|
|
|
nil
|
|
|
|
(mapcar (lambda (el)
|
|
|
|
(if (or broke
|
|
|
|
(and (string-match (regexp-quote org-babel-R-eoe-output)
|
|
|
|
el) (setq broke t)))
|
|
|
|
nil
|
|
|
|
(if (= (length el) 0)
|
|
|
|
nil
|
|
|
|
(if (string-match comint-prompt-regexp el)
|
|
|
|
(substring el (match-end 0))
|
|
|
|
el))))
|
|
|
|
(mapcar #'org-babel-trim raw))))))
|
2009-06-15 18:49:06 +00:00
|
|
|
(case result-type
|
2009-07-19 05:47:37 +00:00
|
|
|
(output (org-babel-chomp (mapconcat #'identity results "\n")))
|
2009-07-19 05:07:07 +00:00
|
|
|
(value (org-babel-import-elisp-from-file tmp-file colnames)))))))
|
2009-07-05 23:19:14 +00:00
|
|
|
|
2009-04-03 23:50:57 +00:00
|
|
|
|
2009-05-24 20:38:01 +00:00
|
|
|
(provide 'org-babel-R)
|
|
|
|
;;; org-babel-R.el ends here
|