Go to file
Matti Pastell e20025315d Changed chunk options to follow Knitr's naming
* Implemented dpi and fig_witdth and fig_height for Gadfly and Winston
2014-12-04 21:54:56 +02:00
examples Changed chunk options to follow Knitr's naming 2014-12-04 21:54:56 +02:00
src Changed chunk options to follow Knitr's naming 2014-12-04 21:54:56 +02:00
test JuliaReport.jl generated files. 2014-11-25 00:08:25 +02:00
.gitignore Changed chunk options to follow Knitr's naming 2014-12-04 21:54:56 +02:00
.travis.yml JuliaReport.jl generated files. 2014-11-25 00:08:25 +02:00
LICENSE.md JuliaReport.jl generated files. 2014-11-25 00:08:25 +02:00
README.md Fixes to Winston support 2014-12-04 17:54:56 +02:00
REQUIRE Initial Gadfly support 2014-12-03 23:34:29 +02:00

README.md

JuliaReport

Build Status

JuliaReport is a scientific report generator/literate programming tool for Julia. It resembles Pweave and, Knitr and Sweave.

Current features

  • Noweb syntax for documents.
  • Execute code as terminal or "script" chunks.
  • Capture PyPlot, Gadfly or Winston figures.
  • Supports latex and pandoc markdown output

Not implemented

  • Script reader
  • Inline code
  • Caching

Chunk options

You can use the same chunk options as for Pweave, but the format is different. Options are separated using ";" and need to be valid Julia expressions. e.g.

<<term=true; fig=false>>=

Usage

Run from julia:

using JuliaReport
weave(Pkg.dir("JuliaReport","examples","julia_sample.mdw")

Using Winston for plots (Julia 0.3 only):

weave(Pkg.dir("JuliaReport","examples","winston_sample.mdw"),
plotlib="Winston", doctype="pandoc")

Using Gadfly (Julia 0.3 only):

weave(Pkg.dir("JuliaReport","examples","gadfly_sample.mdw"), plotlib="Gadfly")