Weave.jl/README.md

44 lines
1.0 KiB
Markdown
Raw Normal View History

2014-12-01 21:41:12 +01:00
# JuliaReport
[![Build Status](https://travis-ci.org/mpastell/JuliaReport.jl.svg?branch=master)](https://travis-ci.org/mpastell/JuliaReport.jl)
JuliaReport is a scientific report generator/literate programming tool
2014-12-02 15:59:26 +01:00
for Julia. It resembles [Pweave](http://mpastell.com/pweave) and, Knitr
and Sweave.
2014-12-01 21:41:12 +01:00
**Current features**
* Noweb syntax for documents.
* Execute code as terminal or "script" chunks.
2014-12-02 15:59:26 +01:00
* Capture PyPlot or Winston figures.
* Supports latex and pandoc markdown output
2014-12-01 21:41:12 +01:00
**Not implemented**
* Script reader
* Inline code
* Caching
## Chunk options
2014-12-02 09:55:32 +01:00
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.
2014-12-01 21:41:12 +01:00
2014-12-02 09:55:32 +01:00
<<term=true; fig=false>>=
2014-12-01 21:41:12 +01:00
## Usage
Run from julia:
using JuliaReport
2014-12-04 14:33:24 +01:00
weave(Pkg.dir("JuliaReport","examples","julia_sample.mdw"))
2014-12-02 09:55:32 +01:00
Or using Winston for plots (Julia 0.3 only):
2014-12-02 15:59:26 +01:00
weave(Pkg.dir("JuliaReport","examples","winston_sample.mdw"),
plotlib="Winston", doctype="pandoc")
2014-12-02 09:55:32 +01:00