logo

Filters

Dexy Filter Reference

Here you will find reference pages for each of the built-in dexy filters. Filters are what let dexy run code, transform text, and wrap libraries and tools so you can easily and reproducibly create any kind of document.

If you have worked through the getting started tutorial, then you are already familiar with some of these filters like pyg and jinja.

You can browse through the alphabetical list or browse filters by tag (not all filters are tagged yet, so the alphabetical list is more reliable).

Alphabetical List of Filters

Symbols

An example is provided for this filter.
This is a newly added filter (in version 1.0.0 or later).
This filter was added after the current released version 2.0.6. Will be in the next dexy release, and is available now if you install dexy from the develop branch.

Tags

R

   sweave: Runs Sweave, generating a .tex file.

asciiart

   cowsay: Runs input through 'cowsay'.

   cowthink: Runs input through 'cowthink'.

   figlet: Runs input through 'figlet'.

asciidoc

   asciidoc: Runs asciidoc command.

   asciidoctor: Runs `asciidoctor`.

c

   c: Compile code using gcc and run.

   cfussy: Compile code using gcc and run, raising an error if compiled code returns nonzero exit.

   cinput: Compile code using gcc and run with input.

   clang: Compile code using clang and run.

   clanginput: compile code using clang and run with input.

clojure

   clj: Runs clojure code, returning stdout.

   cljint: Runs clojure in REPL.

code

   bash: Runs bash scripts using 'bash' and returns stdout.

   c: Compile code using gcc and run.

   cfussy: Compile code using gcc and run, raising an error if compiled code returns nonzero exit.

   cinput: Compile code using gcc and run with input.

   clang: Compile code using clang and run.

   clanginput: compile code using clang and run with input.

   clj: Runs clojure code, returning stdout.

   cljint: Runs clojure in REPL.

   cpp: Compile c++ code using cpp and run.

   cppinput: Compile c++ code using cpp and run with input.

   escript: Runs Erlang scripts using the escript command.

   irb: Runs ruby code in irb.

   irbout: Runs ruby scripts in irb.

   java: Compiles java code and runs main method.

   javac: Compiles java code and returns the .class object

   jirb: Run jruby code in jirb.

   jruby: Run jruby code and return stdout.

   js: Runs code through rhino js interpreter.

   jsint: Runs rhino JavaScript interpeter.

   jython: jython

   jythoni: jython in REPL

   kshint: Runs ksh. Use to run bash scripts.

   lua: Runs code through lua interpreter.

   matlabint: Runs matlab in REPL.

   nodejs: Runs scripts using node js

   perl: Runs perl interpreter.

   php: Runs php file. Php code must be included in tags.

   phpint: Runs PHP in interpeter mode.

   py: Runs Python code and returns stdout.

   pycon: Runs python code in python's REPL.

   pyin: Runs python code and passes input

   r: Runs R in REPL.

   rb: Runs ruby scripts and return stdout.

   rintbatch: Runs R files in batch mode, returning an R console transcript.

   rout: Runs R files in batch mode, returning just the output.

   rust: Runs rust code.

   rusti: Runs rust code in the rust repl (rusti). EXPERIMENTAL.

   scala: Compiles and runs .scala files.

   scalac: Compiles .scala code to .class files.

   scalai: Runs scala code in the REPL.

   sh: Runs bash scripts using 'sh' and returns stdout.

   shint: Runs bash. use to run bash scripts.

   stata: Runs stata files.

   statai: Runs stata files.

compiled

   c: Compile code using gcc and run.

   cfussy: Compile code using gcc and run, raising an error if compiled code returns nonzero exit.

   cinput: Compile code using gcc and run with input.

   clang: Compile code using clang and run.

   clanginput: compile code using clang and run with input.

   cpp: Compile c++ code using cpp and run.

   cppinput: Compile c++ code using cpp and run with input.

   java: Compiles java code and runs main method.

   javac: Compiles java code and returns the .class object

   rust: Runs rust code.

   rust: Runs rust code.

   scala: Compiles and runs .scala files.

   scalac: Compiles .scala code to .class files.

cpp

   cpp: Compile c++ code using cpp and run.

   cppinput: Compile c++ code using cpp and run with input.

deprecated

   html2pdf: Deprecated, use casper.js instead. Renders HTML to PDF using wkhtmltopdf. If the HTML relies on assets such as CSS or image files, these should be specified as inputs. If you have an older version of wkhtmltopdf, and are running on a server, you may get XServer errors. You can install xvfb and run Dexy as `xvfb-run dexy`. Or upgrade to the most recent wkhtmltopdf which only needs X11 client libs.

dot

   dot: Renders .dot files to either PNG or PDF images.

   fdp: Renders .dot files to either PNG or PDF images using fdp.

   rageldot: Generates state chart in .dot format of ragel state machine.

   rlrbd: Generates state chart in .dot format of ragel state machine for ruby.

ebook

   calibre: Runs `ebook-convert` command (part of calibre) Generates various output formats (including .mobi for Kindle) http://manual.calibre-ebook.com/cli/ebook-convert.html

   pandoc: Convert documents to various available output formats using pandoc.

erlang

   escript: Runs Erlang scripts using the escript command.

file-extensions

   bn: Forces previous filter to output .bmp extension.

   cb: Changes file extension to .sh

   ch: Changes file extension to .html

   cj: Changes file extension to .json

   cpickle: Forces previous filter to output .cpickle extension.

   ct: Changes file extension to .txt

   forcer: Forces previous filter to output .R extension.

   fpy: Changes file extension to .py

   gn: Forces previous filter to output .gif extension.

   h: Forces previous filter to output .html extension.

   j: Forces previous filter to output .json extension.

   jn: Forces previous filter to output .jpg extension.

   l: Forces previous filter to output .tex extension.

   p: Forces previous filter to output .pdf extension.

   pickle: Forces previous filter to output .pickle extension.

   pn: Forces previous filter to output .png extension.

   svg: Forces previous filter to output .svg extension.

   t: Forces previous filter to output .txt extension.

   x: Forces previous filter to output .xml extension.

gs

   bw: Converts color pdf to black and white.

   pdf2img: Runs ghostscript to convert PDF files to images. An image file can only hold a single page of PDF, so this defaults to returning page 1. The `page` setting can be used to specify other pages.

   pdf2jpg: Converts a PDF file to a jpg image using ghostscript.

headless

   casperjs: Runs scripts using casper js. Saves cookies.

   phantomjs: Runs scripts using phantom js.

html

   asciidoc: Runs asciidoc command.

   asciidoctor: Runs `asciidoctor`.

   casperjs: Runs scripts using casper js. Saves cookies.

   htlatex: Generates HTML from Latex source using htlatex

   lynxdump: Converts HTML to plain text by using lynx -dump.

   pandoc: Convert documents to various available output formats using pandoc.

   phantomjs: Runs scripts using phantom js.

   tidy: Uses tidy to clean and validate HTML.

   tidycheck: Runs `tidy` to check for valid HTML. This filter does not alter valid HTML. It raises an Exception if invalid HTML is found.

   tidyerrors: Uses tidy to print HTML errors.

image

   dot: Renders .dot files to either PNG or PDF images.

   fdp: Renders .dot files to either PNG or PDF images using fdp.

   inkscape: Runs inkscape in batch mode.

   libreoffice: Converts libreoffice files to other formats.

   pdf2jpg: Converts a PDF file to a jpg image using ghostscript.

   pdftocairo: Runs `pdftocairo` from the poppler library. Converts PDF input to various output formats inclusing SVG.

   unoconv: http://dag.wiee.rs/home-made/unoconv/

info

   sloc: Runs code through sloccount.

   wc: Runs input through wc command line tool.

input

   cinput: Compile code using gcc and run with input.

   clanginput: compile code using clang and run with input.

   cppinput: Compile c++ code using cpp and run with input.

   pyin: Runs python code and passes input

java

   java: Compiles java code and runs main method.

   javac: Compiles java code and returns the .class object

js

   casperjs: Runs scripts using casper js. Saves cookies.

   js: Runs code through rhino js interpreter.

   jsint: Runs rhino JavaScript interpeter.

   nodejs: Runs scripts using node js

   phantomjs: Runs scripts using phantom js.

jvm

   java: Compiles java code and runs main method.

   javac: Compiles java code and returns the .class object

   jython: jython

   jythoni: jython in REPL

   scala: Compiles and runs .scala files.

   scalac: Compiles .scala code to .class files.

jython

   jython: jython

   jythoni: jython in REPL

latex

   htlatex: Generates HTML from Latex source using htlatex

   latexdvi: Run Latex outputting a .dvi file.

   lyx: Runs lyx to generate LaTeX output.

   rst2latex: Runs rst2latex command (docutils).

   wiki2beamer: Converts wiki content to beamer.

   xelatex: Runs .tex files using xelatex.

literate

   sweave: Runs Sweave, generating a .tex file.

lua

   lua: Runs code through lua interpreter.

lyx

   lyx: Runs lyx to generate LaTeX output.

markup

   redcloth: Converts textile to HTML using Redcloth.

   redclothl: Converts textile to LaTeX using Redcloth.

   rst2odt: Runs rst2odt command (docutils).

matlab

   matlabint: Runs matlab in REPL.

music

   abc: Runs `abcm2ps` on .abc music files.

   abcm: Runs `abcm2ps` on .abc music files, generating all output formats.

office

   libreoffice: Converts libreoffice files to other formats.

   unoconv: http://dag.wiee.rs/home-made/unoconv/

parser

   ragel: Generates ruby source code from a ragel file.

   rageldot: Generates state chart in .dot format of ragel state machine.

   rlrbd: Generates state chart in .dot format of ragel state machine for ruby.

pdf

   bw: Converts color pdf to black and white.

   dot: Renders .dot files to either PNG or PDF images.

   embedfonts: Runs ghostscript ps2pdf with prepress settings. Allegedly this helps embed fonts and makes documents friendly for printing.

   epstopdf: Uses epstopdf to convert .eps files to .pdf

   fdp: Renders .dot files to either PNG or PDF images using fdp.

   fopub: Runs fopub on an xml generated by asciidoctor.

   html2pdf: Deprecated, use casper.js instead. Renders HTML to PDF using wkhtmltopdf. If the HTML relies on assets such as CSS or image files, these should be specified as inputs. If you have an older version of wkhtmltopdf, and are running on a server, you may get XServer errors. You can install xvfb and run Dexy as `xvfb-run dexy`. Or upgrade to the most recent wkhtmltopdf which only needs X11 client libs.

   inkscape: Runs inkscape in batch mode.

   libreoffice: Converts libreoffice files to other formats.

   lyx: Runs lyx to generate LaTeX output.

   pdf2img: Runs ghostscript to convert PDF files to images. An image file can only hold a single page of PDF, so this defaults to returning page 1. The `page` setting can be used to specify other pages.

   pdf2jpg: Converts a PDF file to a jpg image using ghostscript.

   pdfcrop: Runs the PDFcrop script http://pdfcrop.sourceforge.net/

   pdfinfo: Uses the pdfinfo script to retrieve metadata about a PDF.

   pdftocairo: Runs `pdftocairo` from the poppler library. Converts PDF input to various output formats inclusing SVG.

   pdftotext: Uses pdftotext from the poppler library to convert PDFs to text.

   ps2pdf: Converts a postscript file to PDF format.

   rd2pdf: Generates a pdf from R documentation file.

   unoconv: http://dag.wiee.rs/home-made/unoconv/

   xelatex: Runs .tex files using xelatex.

perl

   perl: Runs perl interpreter.

php

   php: Runs php file. Php code must be included in tags.

   phpint: Runs PHP in interpeter mode.

python

   py: Runs Python code and returns stdout.

   pycon: Runs python code in python's REPL.

   pyin: Runs python code and passes input

ragel

   ragel: Generates ruby source code from a ragel file.

   rageldot: Generates state chart in .dot format of ragel state machine.

   rlrbd: Generates state chart in .dot format of ragel state machine for ruby.

reStructuredText

   rst2beamer: Runs rst2beamer command (docutils).

   rst2html: Convert rst to HTML

   rst2latex: Runs rst2latex command (docutils).

   rst2man: Runs rst2man command (docutils).

regex

   regetron: Filter which loads .regex file into regetron and runs any input text against it.

repl

   cljint: Runs clojure in REPL.

   irb: Runs ruby code in irb.

   irbout: Runs ruby scripts in irb.

   jirb: Run jruby code in jirb.

   jsint: Runs rhino JavaScript interpeter.

   jythoni: jython in REPL

   kshint: Runs ksh. Use to run bash scripts.

   matlabint: Runs matlab in REPL.

   phpint: Runs PHP in interpeter mode.

   pycon: Runs python code in python's REPL.

   r: Runs R in REPL.

   rintbatch: Runs R files in batch mode, returning an R console transcript.

   rintmock: Experimental filter to run R in sections without using pexpect.

   rusti: Runs rust code in the rust repl (rusti). EXPERIMENTAL.

   scalai: Runs scala code in the REPL.

   shint: Runs bash. use to run bash scripts.

   statai: Runs stata files.

repro

   taverna: Runs workflows in Taverna via command line tool.

rstats

   r: Runs R in REPL.

   rd2pdf: Generates a pdf from R documentation file.

   rdconv: Convert R documentation to other formats.

   rintbatch: Runs R files in batch mode, returning an R console transcript.

   rintmock: Experimental filter to run R in sections without using pexpect.

   rout: Runs R files in batch mode, returning just the output.

ruby

   irb: Runs ruby code in irb.

   irbout: Runs ruby scripts in irb.

   jirb: Run jruby code in jirb.

   jruby: Run jruby code and return stdout.

   ragel: Generates ruby source code from a ragel file.

   rb: Runs ruby scripts and return stdout.

   rlrbd: Generates state chart in .dot format of ragel state machine for ruby.

rust

   rusti: Runs rust code in the rust repl (rusti). EXPERIMENTAL.

scala

   scala: Compiles and runs .scala files.

   scalac: Compiles .scala code to .class files.

   scalai: Runs scala code in the REPL.

screenshots

   casperjs: Runs scripts using casper js. Saves cookies.

   phantomjs: Runs scripts using phantom js.

shell

   bash: Runs bash scripts using 'bash' and returns stdout.

   kshint: Runs ksh. Use to run bash scripts.

   sh: Runs bash scripts using 'sh' and returns stdout.

   shint: Runs bash. use to run bash scripts.

stats

   matlabint: Runs matlab in REPL.

   r: Runs R in REPL.

   rintbatch: Runs R files in batch mode, returning an R console transcript.

   rintmock: Experimental filter to run R in sections without using pexpect.

   rout: Runs R files in batch mode, returning just the output.

   stata: Runs stata files.

   statai: Runs stata files.

sweave

   sweave: Runs Sweave, generating a .tex file.

text

   lynxdump: Converts HTML to plain text by using lynx -dump.

   redcloth: Converts textile to HTML using Redcloth.

   redclothl: Converts textile to LaTeX using Redcloth.

   rst2odt: Runs rst2odt command (docutils).

text-to-speech

   espeak: Runs espeak text to speech.

uml

   plantuml: Runs plantuml and generates an image file.

utils

   man: Read command names from a file and fetch man pages for each. Returns a JSON dict whose keys are the program names and values are man pages.

   sed: Runs a sed script. Any dependencies are assumed to be text files and they have the sed script applied to them.

   strings: Clean non-printing characters from text using the 'strings' tool.

   used: Runs `sed` on the input file. Expects a sed script to be a dependency.

workflow

   taverna: Runs workflows in Taverna via command line tool.

Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.