कैसे Emacs में Knitr वर्कफ़्लो सेटअप करने के लिए?


18

RStudio निट के साथ LaTeX + R स्रोत से पीडीएफ फाइल बनाने के लिए एक-बटन का रास्ता प्रदान करता है। यह प्रतिलिपि प्रस्तुत करने योग्य अनुसंधान करने के लिए बहुत अच्छा लगता है। और मैं इसके लिए अपने Emacs को कॉन्फ़िगर करने की कोशिश कर रहा हूं:

  • Knitr रास्ते में बाएँ बफर LaTeX + R कोड पर;
  • सही बफर पीडीएफ आउटपुट पूर्वावलोकन पर;
  • संकलन के लिए एक प्रमुख संयोजन।

यदि यह संभव है: मुझे यह कैसे सेटअप करना चाहिए, कृपया?

(ईएसएस ठीक काम करता है, लेकिन मुझे नहीं पता कि निटर-वे और वन-बटन-फॉर-संकलन कैसे सेट किया जाए।)


मुझे पूरा यकीन है कि ऐसा करने का एक बेहतर तरीका है, लेकिन मेरे पास वर्तमान में चल रहे एक कुंजी बाइंडिंग rmarkdown::render(के माध्यम से shell-command) के साथ एक छोटा एलिस्फ़ फ़ंक्शन है buffer-file-name, जो अन्य विंडो में पीडीएफ को अपडेट करेगा।
दरोगासी

1
@daroczig लाटेक्स के लिए काम करेगा, या सिर्फ मार्कडाउन?
टायलर

@daroczig: मेरे जवाब में मैंने संभवतः Rnw फ़ाइलों (LaTeX + R) के लिए ऐसा करने की कोशिश की थी। जैसा कि आरएमडी फाइलें (आरएमडी + आर), जो सरल है, कृपया एक अलग पोस्ट शुरू करें।
एंटोनियो

1
मुझे उचित सेटअप नहीं मिला। मुझे पहले पॉलीमोड-वाइव के साथ बुनना होगा। फिर .tex फ़ाइल बनाने के लिए निर्यातक और सब कुछ चुनें। वहां से मुझे लेटेक्स चलाना है। मैंने ऊपर स्क्रिप्ट को अनुकूलित करने की कोशिश की, लेकिन मेरी योग्यता अभी तक नहीं है। जो मैं चाहता हूं वह है .Rnw-file को बुनना, pdf (pdflatex) बनाना और इसे देखना। मैंने अपना सिस्टम सेट किया, कि अगर मैं लेटेक्स फ़ाइल में "Cc Ca" (टेक्स-कमांड-रन-ऑल) टाइप करता हूं, तो पीडीएफ बनाया और देखा जाता है, लेकिन मैं my_knitr () से टेक्स-फाइल पर उस फ़ंक्शन को कॉल नहीं कर सकता । मदद की सराहना की जाएगी। (defun my_knitr () "R-Poly मोड में Knitr चलाएँ और pdf बनाएँ और देखें" (अन्तरक्रिया
Krisselack

@ क्रिसलैक ऐसा लगता है कि मैं नीचे दिए गए मेरे उत्तर में वर्णित सुविधाओं को ईएसएस से हटा दिया गया है। मुझे उनके द्वारा उपयोग किए गए नए दृष्टिकोण को प्रतिबिंबित करने के लिए इसे अपडेट करना होगा
टायलर

जवाबों:


12

अपडेट करें

ESS 19.04 तक, ess-nowebऔर ess-swvपुस्तकालय अप्रचलित हैं:

  • साक्षर डेटा विश्लेषण के लिए पुस्तकालय अप्रचलित हैं और डिफ़ॉल्ट रूप से लोड नहीं किए गए हैं। इसमें 'Ess-Noweb', 'Ess-swv' और 'Rnw-mode' जैसी संबंधित कार्यक्षमता शामिल है। उपयोगकर्ताओं को इन मोड्स से निपटने वाले कई अन्य पैकेजों में से एक पर स्विच करने के लिए प्रोत्साहित किया जाता है। उदाहरण के लिए, पॉलीमोड https://github.com/polymode/poly-R/ , https://polymode.github.io/ , या एडिट-इनडायरेक्ट https://jblevins.org/projects/markdown- के साथ मार्कडाउन -मोड मोड

नतीजतन, मेरा मूल उत्तर (नीचे) अब लागू नहीं होता है। इन पुस्तकालयों को प्रदान करने के लिए उपयोग की जाने वाली सुविधाएँ अब पॉलीमोड द्वारा प्रदान की जाती हैं, और कॉन्फ़िगरेशन सरल है। न्यूनतम समर्थन पाने के लिए ess, आपको polymodeऔर poly-RMELPA (या यदि आप कैसे रोल करते हैं, स्रोत से) पैकेज स्थापित करना है ।

बस! अब यदि आप एक Rnwफ़ाइल खोलते हैं , तो आपको PM-Rnwमॉडल में ध्वज देखना चाहिए , और Polymodeशीर्ष पर एक मेनू होगा । आप (या पॉलीमोड मेनू) के .texमाध्यम से अपनी फ़ाइल को एक फ़ाइल में बुनाई कर सकते हैं M-n w, और इसे (या मेनू) के .pdfमाध्यम से निर्यात कर सकते हैं M-n e। पहली बार ऐसा करने पर आपको एक निर्यातक के लिए संकेत दिया जाएगा; मैंने अभी-अभी उठाया knitr

नोट: निर्यात ( M-n e) स्वचालित रूप से आपका कोड चलाता है, पीडीएफ उत्पन्न करता है और इसे प्रदर्शित करता है, सभी एक बार में। मैं नीचे वर्णित पुराने संस्करण के साथ उस "एक-क्लिक" व्यवहार को प्राप्त करने में सक्षम नहीं था।

उत्पन्न फ़ाइलों में शब्द -wovenऔर -exportedसंलग्न होगा। यदि आपको यह पसंद नहीं है, तो आप विकल्पों को कस्टमाइज़ कर सकते हैं polymode-weaver-output-file-formatऔर polymode-exporter-output-file-format

प्रक्रिया RMarkdown फ़ाइलों ( .Rmd) के लिए समान है ।

पॉलीमोड मैनुअल में पूर्ण विवरण प्रदान किया गया है

मूल उत्तर (ईएसएस 19.04 के बाद अप्रचलित)

तीन चर सेट करने की आवश्यकता है:

  1. ess-swv-pdflatex-commands, अनुकूलन समूह ess-sweaveमें पहले कमांड के रूप में "pdflatex" होना चाहिए। जैसे, यह कुछ इस तरह दिखना चाहिए:("pdflatex" "texi2pdf" "make")
  2. ess-swv-processor, अनुकूलन समूह में ess-R, मान होना चाहिए"knitr"
  3. ess-pdf-viewer-prefकरने के लिए अनुकूलन समूह essमें "emacsclient"। यह मानता है कि आप emacs सर्वर चला रहे हैं, या emacs - मोड में चल रहा है। यदि संभव हो तो आपको पीडीएफ-टूल्स का भी उपयोग करना चाहिए , क्योंकि यह अंतर्निहित एमएसीएस दर्शक के लिए बहुत बेहतर है।

मैं BibTeX और texi2pdf को कॉल करने के लिए दो कीबाइंडिंग जोड़ने के लिए एक हुक का उपयोग करता हूं:

(add-hook 'ess-noweb-mode-hook 'my-noweb-hook)

(defun my-noweb-hook ()
  (define-key ess-noweb-mode-prefix-map "b"
    #'(lambda () (interactive) (TeX-command "BibTeX" 'TeX-master-file)))
  (define-key ess-noweb-mode-prefix-map "P"
    #'(lambda () (interactive)
        (ess-swv-PDF "texi2pdf"))))

एक बार जब यह किया जाता है, M-n sतो आपके दस्तावेज़ को बुनना होगा, M-n bइसे bibtex करेगा, और M-n Pइसे pdflatex के साथ संसाधित करेगा।

ध्यान दें कि बुनाई पूरी होने पर Emacs के लिए कोई सरल तरीका नहीं है, इसलिए आप इसे एक चरण में बुनना और लेटेक्स तक सेट नहीं कर सकते हैं; बुनाई समाप्त होने के बाद आपको मैन्युअल रूप से pdflatex को ट्रिगर करना होगा ।

यहां कई चरणों को देखते हुए - Rnw -> लेटेक्स -> पीडीएफ, मुझे नहीं लगता कि आप अपने पीडीएफ और Rnw फ़ाइलों को एक साथ स्क्रॉल करने के लिए Synctex प्राप्त कर सकते हैं, लेकिन मैं गलत साबित होने के लिए रोमांचित हूं।

जहां तक ​​खिड़की की व्यवस्था की बात है, मैं उन्हें वहां नहीं रख सकता जहां मैं चाहता हूं। इसलिए क्षतिपूर्ति करने के लिए मैं खिड़कियों और बफ़रों में फेरबदल करने में काफी माहिर हो गया हूं क्योंकि मुझे उनकी आवश्यकता है;)

Yihui ने निट साइट पर एक छोटा वीडियो पोस्ट किया, जिसमें से कुछ का प्रदर्शन किया गया।


मैंने अपने .emacs से सभी आवश्यक कॉन्फ़िगर, और सिर्फ़ ज़रूरी कॉन्फ़िगर निकालने की पूरी कोशिश की है। मुझे कुछ याद आ गया होगा, यह बालों की तरह है।
टायलर

मेरे लिए यह संभव हो गया कि मैं निट के दस्तावेज संकलित करूं। लेकिन फिर भी एक-कुंजी कॉम्बो (Rnw -> पीडीएफ के लिए) खोजने की कोशिश करें। आशा है कि यह संभव है, क्योंकि Rstudio में यह है।
drobnbobn

@ टायलर: धन्यवाद, आपका समाधान एक आकर्षण ootb की तरह काम करता है (यहां तक ​​कि विन्यास को संपादित किए बिना)! पैकेज: निबंध, पॉलीमोड, पॉली-आर
क्रिसेलेक

5

यह एक ऑल-इन-वन समाधान है। यह एक Rnw से एक पीडीएफ बनाएगा और प्रदर्शित करेगा
विशेष रूप से यह होगा:

  1. Rnw बफर सहेजें और इसे बुनें,
  2. दी गई TeX फ़ाइल के लिए दिए गए LaTeX इंजन को लागू करें,
  3. BibTeX इंजन निष्पादन योग्य (उदाहरण के लिए biber, bibtex8) को पहचानें,
  4. TeX फ़ाइल पर BibTeX इंजन चलाएँ यदि bib फ़ाइल TeX फ़ाइल से नई है,
  5. फिर से LaTeX चलाएं, नामित दर्शक में 6 ओपन परिणामस्वरूप पीडीएफ।

यदि उपरोक्त चरणों में से एक विफल हो जाता है तो प्रक्रिया सूचनात्मक संदेशों के साथ बाहर निकलने की कोशिश करती है।
एक आर उदाहरण खोला जाएगा, यदि आवश्यक हो, या वर्तमान एक को बुनाई प्रक्रिया दिखाने के लिए उपयोग किया जाता है।
LaTeX आउटपुट "TeX-output" बफर को भेजा जाता है, जो संकलन त्रुटि के मामले में भी पॉपअप होता है।

प्रयोग

Meta- x knit-meपीडीएफ बनाने और देखने के लिए।
Meta- x knit-me-clearमध्यवर्ती LaTeX फ़ाइलों को हटाने के लिए और knit-me

ग्रंथ सूची के लिए "biblatex" पैकेज की आवश्यकता होती है, अर्थात:

\usepackage[
    options...      
    backend=ENGINE,
]{biblatex}
\addbibresource{foo.bib}

कीवर्ड को पार्स करते हुए बिब-इंजन (उदा bibtexbiber) का नाम प्राप्त किया जाता है backend
\addbibresourceकमांड को ग्रंथ सूची फ़ाइल प्राप्त करने के लिए तैयार किया जाता है: यदि foo.bibTeX फ़ाइल की तुलना में नया है तो बिब इंजन चलाया जाता है। इस संबंध में, कई होने पर केवल पहली \addbibresourceकमांड को ध्यान में रखा जाता है।

अनुकूलित करें

पीडीएफ को वास्तव में देखने के लिए, दर्शक निष्पादन योग्य पथ को इसके साथ सेट करें:

(setq pdf-viewer "path/to/pdf-viewer")

संभवतः SumatraPDF जैसे एक दर्शक का उपयोग करें , जो स्वचालित रूप से पीडीएफ को अपडेट करता है जब पुन: संकलित किया जाता है और नई संकलनों को रोकने वाली खुली हुई फ़ाइल को ब्लॉक नहीं करता है।

डिफ़ॉल्ट LaTeX इंजन है pdflatex(वर्तमान पथ में माना जाता है)। के साथ अनुकूलित करें:

(setq latex-engine "newengine"
      latex-args   "--option-1 --option-2")

बेशक आप बाँधना चाहते हैं knit-meऔर knit-me-clearकुछ सुविधाजनक चाबियाँ।

टिप्पणियाँ

biberऔर पीछे bibtex8और GNU Emacs 25.1.1 के साथ, विंडोज MiKTeX में परीक्षण किया गया ।

विशिष्ट कोड

;; (require 'ess-site) ; assumed in your init file

(defun knit-me-clear () 
  "Delete intermediate LaTeX files and run `knkt-me'.
These are based on extensions .aux, .blg, .out, .run.xml, .bbl, .log, -blx.bib"

  (interactive)
  (check-Rnw)
  (let
      ((file)
       (stem (file-name-sans-extension (buffer-file-name))))
    (dolist (elt
         (list ".aux" ".blg" ".out" ".run.xml" ".bbl" ".log" "-blx.bib"))
      (setq file (concat stem elt))
      (if (file-exists-p file) (delete-file file))))  
  (knit-me))


(defun knit-me () 
  "Knit->LaTeX-engine->bibtex-engine->LaTeX-engine->View.
Default LaTeX engine is \"pdflatex\" and can be customised with `latex-engine';
default LaTeX arguments are set to nil and can be customised with `latex-args';
default PDF viewer is set to nil and can be customised with `pdf-viewer'.
Bibliography must be set via \"biblatex\" LaTeX package.
Bibliography engine is obtained from \"backend\" option in \"biblatex\" package.
A reference  LaTeX bib file is obtained from the first LaTeX command \"\addbibresource{foo.bib}\".
The biblatex-engine is run if the bib file is newer of the TeX file. 
If there are multiple \"\addbibresource\" only the first will be used to decide whether to run the biblatex-engine."

  (interactive)

  ;; Default values
  (defvar pdf-viewer nil)
  (defvar latex-engine "pdflatex")
  (defvar latex-args nil)

  (check-Rnw)

  ;;If 1 R-proc found, associate it with buffer;
  ;;if many found, ask to choose one; if none found, launch and associate
  (ess-force-buffer-current "Process to use: ")

  ;;Save Rnw buffer
  (save-buffer)


  (let*
      (;;Set file paths
       (pathstem (file-name-sans-extension (buffer-file-name)))
       (namestem (file-name-nondirectory pathstem))
       (cur-dir     (file-name-directory pathstem))
       (rnw-name    (concat namestem ".Rnw"))
       (tex-name    (concat namestem ".tex"))

       ;;Create LaTeX commmand
       (latex-args (concat latex-args " " namestem))
       (latex-cmd (concat latex-engine " " latex-args))

       ;;Create knit commmand
       (knit-cmd (format "require(knitr); setwd('%s'); knit('%s')"  cur-dir rnw-name))

       ;;Get R buffer proc
       (r-proc (ess-get-process))
       (r-buf (ess-get-process-buffer))

       ;;TeX executable process and bibtex engine/file
       (tex-proc)
       (tex-buf)
       (bibfile (bib-getfile))
       (bibengine (bib-getengine))
       (bibfile-updated
    (file-newer-than-file-p
     (concat cur-dir (file-name-nondirectory bibfile) ".bib") (concat pathstem ".tex")))


       ;;Command success
       (success nil)
       (error-msg "")
       )


    (setq default-directory cur-dir)

    ;; Exit on error
    (catch 'exit-func

      ;;Check bibtex file and engine
      (when (not bibfile)
    (setq error-msg (bib-getfile t))
    (throw 'exit-func nil))     
      (when (not bibengine)
    (setq error-msg (bib-getengine t))      
    (throw 'exit-func nil))

      ;; Biber wants .bib
      (let ((fail (and (string= bibengine "biber")
              (string= (file-name-nondirectory bibfile) (file-name-base bibfile)))))
    (setq success (not fail)))
      (when (not success)
    (setq error-msg
          (format "biber wants \\addbibresource{%s%s}" (file-name-base bibfile) ".bib"))
    (throw 'exit-func nil))


      ;; Knitting
      (switch-to-buffer-other-window r-buf)
      (message knit-cmd)
      (ess-eval-linewise knit-cmd nil t nil t) 
      ;; Foll. 3 lines are an alternative to ess-eval
      ;; (inferior-ess-mark-as-busy r-proc)  ; knit immediately after this line       
      ;; (process-send-string r-proc (format "cat(\"%s\");%s\n" knit-cmd knit-cmd)) ; real 
      ;; (ess-wait-for-process r-proc nil)

      ;; Check for knitting results
      (with-current-buffer r-buf
    ;; Parse last 3 lines
    (let ((beg) (end) (out))
      (goto-char (point-max))
      (setq end (point))
      (forward-line -3) 
      (setq beg (point))
      (setq out (buffer-substring-no-properties beg end))

      ;; Knitting successful?
      (setq success "output file: %s\n\n[1] \"%s\"\n> ")
      (setq success (string= (format success tex-name tex-name) out))))

      (when (not success)
    (setq error-msg (concat "Unable to knit " rnw-name))
    (throw 'exit-func nil))

      ;; First LaTeXing
      (setq tex-buf (get-buffer-create "TeX-output")) ; Create output buffer or use existing
      (with-current-buffer tex-buf                   
    (buffer-disable-undo)
    (erase-buffer))
      (message "1st latex ...")
      (send-r-mess (format "Starting LaTeX (see \"%s\")" (buffer-name tex-buf)))      
      (send-r-mess latex-cmd)
      (setq success (= 0 (call-process latex-engine nil tex-buf t latex-args)))
      (goto-char (point-max))

      ;; Check 1st LaTeX results
      (when (not success)
    (setq error-msg (concat "Unable to LaTeX " namestem))
    (switch-to-buffer-other-window tex-buf) 
    (other-window 1)
    (throw 'exit-func nil))

      ;; Run bibtex engine
      (when bibfile-updated  
    (message "biblatex ...")
    (send-r-mess (concat bibengine " "  namestem))
    (setq success (= 0 (call-process bibengine nil tex-buf t namestem)))
    (goto-char (point-max))

    ;; Check bibtex results
    (when (not success)
      (setq error-msg (concat "Unable to " bibengine " " namestem))
      (switch-to-buffer-other-window tex-buf) 
      (other-window 1)
      (throw 'exit-func nil)))

      ;; Second LaTeXing
      (message "2nd latex ...")
      (send-r-mess latex-cmd)
      (setq success (= 0 (call-process latex-engine nil tex-buf t latex-args)))
      (goto-char (point-max))

      ;; Check 2nd LaTeX results
      (when (not success)
    (setq error-msg (concat "Unable to LaTeX " pathstem))
    (switch-to-buffer-other-window tex-buf) 
    (other-window 1)
    (throw 'exit-func nil))

      ;; View   
      (if (not pdf-viewer) (throw 'exit-func nil))
      (send-r-mess  "...and now the viewer")
      (goto-char (point-max))
      (setq success (file-exists-p pdf-viewer))
      (when (not success)
    (setq error-msg (concat "Can\\'t find executable " pdf-viewer))
    (throw 'exit-func nil))

      ;; If you need viewer console output, use "(start-process "pdf-viewer" tex-buf ...";
      ;; but you block tex-buf buffer till the viewer is open
      (start-process "pdf-viewer" nil pdf-viewer (concat namestem ".pdf")))

    (if success
    (if bibfile-updated (message (concat "Updated to "  (file-name-nondirectory bibfile))))
      (message error-msg)
      (send-r-mess error-msg))))

(defun bib-getfile(&optional show-messages)
  "Check if 'addbibresource' command and related file exist. 
If found, return .bib file full path, else:
if SHOW-MESSAGES is nil return nil, if SHOW-MESSAGES is non-nil return related error."
  (save-excursion
    (goto-char (point-min))
    (re-search-forward "\\\\addbibresource{\\(.+\\)}" nil t))
  (let ((fmatch (match-string-no-properties 1)) 
    (success nil)
    mess)    
    (cond 
     ((not fmatch) (setq mess "Missing \\addbibresource command."))
     ((not (file-exists-p (concat (file-name-sans-extension fmatch) ".bib")))
      (setq mess (concat "Missing file: " fmatch ".bib")))
     ;; if no problem, sucess=message=bib-file-path
     (t (setq mess (concat (file-name-directory (buffer-file-name)) fmatch)
          success mess)))

    (if show-messages mess success)))

(defun bib-getengine(&optional show-messages)
  "Find biblatex engine.
If found,  engine name, else:
if SHOW-MESSAGES is nil return nil, if SHOW-MESSAGES is non-nil return related error."
  (save-excursion
    (goto-char (point-min))
    (let ((pack (re-search-forward "\\\\usepackage *\\(\\[[^]]*\\)\\] *{ *biblatex *}" nil t))
      (bend nil)
      mess)

      (when pack (setq pack (match-string-no-properties 1)))
      (when (and pack
         (string-match "[^[:alpha:]]+backend *= *\\([^, \n]+\\)" pack))
    (setq bend (match-string 1 pack)))
      (cond 
       ((not pack) (setq mess "Missing biblatex package command."))
       ((not bend) (setq mess "Missing biblatex backend."))
       ;; if no problem, sucess=message=bib-file-path
       (t (setq mess bend)))
      (if show-messages mess bend))))


(defun send-r-mess (mess)
  "Just send MESS at the end of R console buffer"
  (process-send-string (ess-get-process)
             (format "cat('%s\\n')\n" mess)))

(defun check-Rnw ()
  "Give error if `ess-dialect' is not \"R\""
  (if (not (string= "R" ess-dialect))
      (error "Not an Rnw buffer")))
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.