Go to file
Matti Pastell b6aa8289de Added .gitignore 2014-11-27 13:41:59 +02:00
examples Added .gitignore 2014-11-27 13:41:59 +02:00
src Exception handling for invalid chunk options 2014-11-27 13:09:42 +02:00
test JuliaReport.jl generated files. 2014-11-25 00:08:25 +02:00
.gitignore Added .gitignore 2014-11-27 13:41:59 +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 Readme typo 2014-11-27 11:53:56 +02:00
REQUIRE Add a requirement of the PyPlot package (which, in turn, requires PyCall). 2014-11-25 10:02:17 -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. The syntax needs to be valid for creating a dictionary in Julia without the {}. e.g:

<<"term"=>true, "fig"=>false>>=

Usage

Run from julia:

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