Go to file
Matti Pastell a12773af60 Updated Readme 2014-12-02 10:55:32 +02:00
examples Updated Readme 2014-12-02 10:55:32 +02:00
src Parse the chunk options as a set of Julia expressions and store options in a Dict{Symbol,Any} 2014-12-01 16:58:12 -06:00
test JuliaReport.jl generated files. 2014-11-25 00:08:25 +02:00
.gitignore Updated Readme 2014-12-02 10:55:32 +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 Updated Readme 2014-12-02 10:55:32 +02:00
REQUIRE Parse the chunk options as a set of Julia expressions and store options in a Dict{Symbol,Any} 2014-12-01 16:58:12 -06:00

README.md

JuliaReport

Build Status

JuliaReport is a scientific report generator/literate programming tool for Julia. It is based on Pweave and resembles Knitr and Sweave. Actually JuliaReport relies on Pweave for document parsing and formatting.

You'll need latest Pweave from Github: https://github.com/mpastell/Pweave.

Current features

  • Noweb syntax for documents.
  • Execute code as terminal or "script" chunks.
  • Capture PyPlot figures.
  • All Pweave output formats supported. Including, Latex, Markdown, Sphinx etc.

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")

Or using Winston for plots (Julia 0.3 only):

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