Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fniessen/refcard-org-babel

Org Babel reference card
https://github.com/fniessen/refcard-org-babel

Last synced: 3 months ago
JSON representation

Org Babel reference card

Awesome Lists containing this project

README

        

#+TITLE: Org Babel reference card
#+AUTHOR: Fabrice Niessen
#+EMAIL: (concat "fniessen" at-sign "pirilampo.org")
#+DESCRIPTION: Org Babel reference card
#+KEYWORDS: emacs, org-mode, org-babel, eric shulte, dan davison, literate programming, reproducible research, sweave
#+LANGUAGE: en
#+OPTIONS: H:4 num:nil toc:2

#+SETUPFILE: https://fniessen.github.io/org-html-themes/setup/theme-readtheorg.setup

#+PROPERTY: header-args :eval never

#+begin_html


#+end_html

#+begin_html

:license-gpl-blue.svg


btn_donate_LG.gif

#+end_html

#+begin_quote
[!TIP]

*** Elevate your Emacs skills in Paris, Utrecht, Leuven or Valencia!
*Unlock the power of Emacs! Join my next exclusive "Emacs Boost" course!*

Ready to /supercharge your productivity/ and become an Emacs ninja? Look no
further!

*What you'll learn:*
- Master Emacs from the basics to advanced tricks.
- /Boost your editing efficiency/ and streamline your workflow.
- Customize Emacs to fit your unique needs.
- And much more!

*Audience:*

Open to anyone interested in Emacs, from beginners to advanced
users.

*Why choose my course?*
- Expert instructor with 25 years of Emacs experience.
- /Hands-on exercises/ to reinforce your learning.
- /Networking opportunities/ with like-minded Emacs enthusiasts.
- Personalized attention.

Don't miss this opportunity to take your Emacs skills to the next level! \\

Visit https://emacsboost.com/en/ for more information, dates and locations, and
to /reserve your seat/.
#+end_quote

* Introduction

Welcome to Org Babel reference card. It contains the reference documentation
that describes how to perform *code execution* within Org mode documents using Org
Babel 8.

In a nutshell, Org Babel is like Sweave (for [[id:1663ff41-af51-4b07-abc8-6bfed9395b2b][reproducible research]]) but it takes
a *large number of possible languages* (C, Java, Python, Ruby, R, ...) and Org
mode can produce *HTML* as well as *PDF*.

#+begin_warning
Prolonged use may cause addiction!
#+end_warning

# See http://faculty.washington.edu/kenrice/sisg-adv/SweaveIntro.pdf for intro
# about Sweave.

# * Example
#
# http://www.johndcook.com/blog/2012/12/20/basics-of-sweave-and-pweave/
#
# Here is a sample Org file:
#
# Invisible code that sets the value of the variable ~a~.
#
# <<>=
# a <- 3.14
# @
#
# Visible code that sets ~b~ and squares it.
#
# <>=
# b <- 3.15
# b*b
# @
#
# Calling R inline: $\sqrt{2} = Sexpr{sqrt(2)}$
#
# Recalling the variable $a$ set above: $a = Sexpr{a}$.
#
# Here's a figure:
#
# <>=
# x <- seq(0, 6*pi, length=200)
# plot(x, sin(x))
# @

* Documentation

See http://org-babel.readthedocs.org/ for full documentation.

*NOTE --* Please be aware that when viewing this content on the web, the example
org-babel blocks may not be visible due to rendering limitations. To see the
complete content, it is recommended to *use Emacs* and *open the =.org= files
directly*.