Renamed package to Weave,jl as discussed in mpastell:pull-request/54b50af2

pull/17/head
Matti Pastell 2014-12-08 10:25:57 +02:00
parent 51c1279787
commit 97b7c0f26d
8 changed files with 28 additions and 28 deletions

View File

@ -14,6 +14,6 @@ before_install:
- sudo apt-get install libpcre3-dev julia -y
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
script:
- julia -e 'Pkg.init(); Pkg.add("Cairo"); Pkg.add("Gadfly"); Pkg.clone(pwd()); Pkg.test("JuliaReport", coverage=true)'
- julia -e 'Pkg.init(); Pkg.add("Cairo"); Pkg.add("Gadfly"); Pkg.clone(pwd()); Pkg.test("Weave", coverage=true)'
after_success:
- julia -e 'cd(Pkg.dir("JuliaReport")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
- julia -e 'cd(Pkg.dir("Weave")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'

View File

@ -1,4 +1,4 @@
The JuliaReport.jl package is licensed under the MIT "Expat" License:
The Weave.jl package is licensed under the MIT "Expat" License:
> Copyright (c) 2014: Matti Pastell.
>

View File

@ -1,8 +1,8 @@
# JuliaReport
# Weave
[![Build Status](https://travis-ci.org/mpastell/JuliaReport.jl.svg?branch=master)](https://travis-ci.org/mpastell/JuliaReport.jl)[![Coverage Status](https://img.shields.io/coveralls/mpastell/JuliaReport.jl.svg)](https://coveralls.io/r/mpastell/JuliaReport.jl?branch=master)
[![Build Status](https://travis-ci.org/mpastell/Weave.jl.svg?branch=master)](https://travis-ci.org/mpastell/Weave.jl)[![Coverage Status](https://img.shields.io/coveralls/mpastell/Weave.jl.svg)](https://coveralls.io/r/mpastell/Weave.jl?branch=master)
JuliaReport is a scientific report generator/literate programming tool
Weave is a scientific report generator/literate programming tool
for Julia. It resembles [Pweave](http://mpastell.com/pweave) and, Knitr
and Sweave.
@ -23,7 +23,7 @@ and Sweave.
## Chunk options
I've tried to follow [Knitr](http://yihui.name/knitr/options)'s naming for chunk options, but not all options are implemented.
You can see [`src/config.jl`](https://github.com/mpastell/JuliaReport.jl/blob/master/src/config.jl) for the current situation.
You can see [`src/config.jl`](https://github.com/mpastell/Weave.jl/blob/master/src/config.jl) for the current situation.
Options are separated using ";" and need to be valid Julia expressions. e.g.
@ -48,21 +48,21 @@ tex: Latex with custom code environments
Run from julia:
````julia
using JuliaReport
weave(Pkg.dir("JuliaReport","examples","julia_sample.mdw")
using Weave
weave(Pkg.dir("Weave","examples","julia_sample.mdw")
````
Using Winston for plots (Julia 0.3 only):
````julia
weave(Pkg.dir("JuliaReport","examples","winston_sample.mdw"),
weave(Pkg.dir("Weave","examples","winston_sample.mdw"),
plotlib="Winston", doctype="pandoc")
````
Using Gadfly (Julia 0.3 only):
````julia
weave(Pkg.dir("JuliaReport","examples","gadfly_sample.mdw"), plotlib="Gadfly")
weave(Pkg.dir("Weave","examples","gadfly_sample.mdw"), plotlib="Gadfly")
````
The signature of weave functions is:
@ -72,11 +72,11 @@ function weave(source ; doctype = "pandoc",
plotlib="PyPlot", informat="noweb", fig_path = "figures", fig_ext = nothing)
````
**Note:** Run JuliaReport from terminal and not using IJulia, Juno or ESS, they tend to mess with capturing output.
**Note:** Run Weave from terminal and not using IJulia, Juno or ESS, they tend to mess with capturing output.
## Contributing
I will probably add new features to JuliaReport when I need them myself or if they are requested and not too difficult to implement. You can contribute by opening issues on Github or implementing things yourself and making a pull request. I'd also appreciate example documents written using JuliaReport to add to examples.
I will probably add new features to Weave when I need them myself or if they are requested and not too difficult to implement. You can contribute by opening issues on Github or implementing things yourself and making a pull request. I'd also appreciate example documents written using Weave to add to examples.
## Contributors

View File

@ -1,15 +1,15 @@
# Introducion to JuliaReport
# Introducion to Weave
This a sample [Julia](http://julialang.org/) noweb document that can
be executed using JuliaReport. Output from code chunks and PyPlot
plots will be included in the weaved document. You also need to install Pweave from Github in order to use JuliaReport.
be executed using Weave. Output from code chunks and PyPlot
plots will be included in the weaved document. You also need to install Pweave from Github in order to use Weave.
This documented can be turned into Pandoc markdown with captured
result from Julia prompt.
~~~~{.julia}
using JuliaReport
using Weave
weave("examples/julia_sample.mdw")
~~~~
@ -17,7 +17,7 @@ weave("examples/julia_sample.mdw")
<<term=true>>=
x = 1:10
d = {"juliareport" => "testing"}
d = {"Weave" => "testing"}
y = [2, 4 ,8]
@

Binary file not shown.

View File

@ -1,23 +1,23 @@
# Introducion to JuliaReport
# Introducion to Weave
This a sample [Julia](http://julialang.org/) noweb document that can
be executed using JuliaReport. Output from code chunks and Winston
plots will be included in the weaved document. You also need to install Pweave from Github in order to use JuliaReport.
be executed using Weave. Output from code chunks and Winston
plots will be included in the weaved document. You also need to install Pweave from Github in order to use Weave.
This documented can be turned into Pandoc markdown with captured
result from Julia prompt.
~~~~{.julia}
using JuliaReport
weave(Pkg.dir("JuliaReport","examples","winston_sample.mdw"), plotlib="Winston")
using Weave
weave(Pkg.dir("Weave","examples","winston_sample.mdw"), plotlib="Winston")
~~~~
## Terminal chunk
<<term=true>>=
x = 1:10
d = {"juliareport" => "testing"}
d = {"Weave" => "testing"}
y = [2, 4 ,8]
@

View File

@ -1,4 +1,4 @@
module JuliaReport
module Weave
using Compat
#Contains report global properties
@ -76,13 +76,13 @@ function weave(source ; doctype = "pandoc", plotlib="PyPlot", informat="noweb",
else
l_plotlib = lowercase(plotlib)
if l_plotlib == "winston"
eval(parse("""include(Pkg.dir("JuliaReport","src","winston.jl"))"""))
eval(parse("""include(Pkg.dir("Weave","src","winston.jl"))"""))
rcParams[:plotlib] = "Winston"
elseif l_plotlib == "pyplot"
eval(Expr(:using, :PyPlot))
rcParams[:plotlib] = "PyPlot"
elseif l_plotlib == "gadfly"
eval(parse("""include(Pkg.dir("JuliaReport","src","gadfly.jl"))"""))
eval(parse("""include(Pkg.dir("Weave","src","gadfly.jl"))"""))
rcParams[:plotlib] = "Gadfly"
end
end

View File

@ -1,4 +1,4 @@
using JuliaReport
using Weave
using Base.Test