Weave.jl/README.md

40 lines
1.0 KiB
Markdown
Raw Normal View History

# JuliaReport
[![Build Status](https://travis-ci.org/mpastell/JuliaReport.jl.svg?branch=master)](https://travis-ci.org/mpastell/JuliaReport.jl)
2014-11-25 00:10:48 +01:00
JuliaReport is a scientific report generator/literate programming tool
for Julia. It is based on [Pweave](http://mpastell.com/pweave) and
resembles Knitr and Sweave. Actually JuliaReport relies on Pweave for
document parsing and formatting.
2014-11-25 11:17:12 +01:00
You'll need latest Pweave from Github: <https://github.com/mpastell/Pweave.>
2014-11-25 00:10:48 +01:00
**Current features**
2014-11-27 10:07:44 +01:00
* Noweb syntax for documents.
2014-11-25 00:10:48 +01:00
* Execute code as terminal or "script" chunks.
* Capture PyPlot figures.
* All Pweave output formats supported. Including, Latex, Markdown, Sphinx etc.
**Not implemented**
2014-11-27 10:07:44 +01:00
* Script reader
2014-11-25 00:10:48 +01:00
* Inline code
* Caching
2014-11-27 10:07:44 +01:00
## Chunk options
2014-11-25 00:10:48 +01:00
2014-11-27 10:07:44 +01:00
You can use the same chunk options as for Pweave, but the format is different.
2014-11-27 10:53:13 +01:00
The syntax needs to be valid for creating a dictionary in Julia
without the `{}`. e.g:
2014-11-25 00:10:48 +01:00
2014-11-27 10:53:56 +01:00
<<"term"=>true, "fig"=>false>>=
2014-11-25 00:10:48 +01:00
2014-11-27 10:07:44 +01:00
## Usage
2014-11-25 00:10:48 +01:00
2014-11-27 10:07:44 +01:00
Run from julia:
using JuliaReport
weave(Pkg.dir("JuliaReport","examples","julia_sample.mdw")