Chunk Options
I've mostly followed Knitr's naming for chunk options, but not all options are implemented.
Options are separated using ";" and need to be valid Julia expressions. Example: markdown code chunk that saves and displays a 12 cm wide image and hides the source code:
julia; out_width="12cm"; echo=false
Weave currently supports the following chunk options with the following defaults:
Options for Code
echo = true: Echo the code in the output document. Iffalsethe source code will be hidden.results = "markup": The output format of the printed results."markup"for literal block,"hidden"for hidden results, or anything else for raw output (I tend to use"tex"for Latex and"rst"for rest). Raw output is useful if you want to e.g. create tables from code chunks.eval = true: Evaluate the code chunk. Iffalsethe chunk won’t be executed.term = false: Iftruethe output emulates a REPL session. Otherwise only stdout and figures will be included in output.label = nothing: Chunk label, will be used for figure labels in Latex asfig:label.wrap = true: Wrap long lines from output.line_width = 75: Line width for wrapped lines.cache = false: Cache results, depending oncacheparameter onweavefunction.hold = false: Hold all results until the end of the chunk.tangle = true: Set tangle tofalseto exclude chunk from tangled code.
Options for Figures
fig_width = 6: Figure width passed to plotting library.fig_height = 4: Figure height passed to plotting library.out_width: Width of saved figure in output markup e.g."50%","12cm",0.5\linewidthout_height: Height of saved figure in output markupdpi = 96: Resolution of saved figures.fig_cap: Figure caption.label: Chunk label, will be used for figure labels in Latex as fig:labelfig_ext: File extension (format) of saved figures.fig_pos = "!h": Figure position in Latex, e.g.:"ht".fig_env = "figure": Figure environment in Latex.
Set Default Chunk Options
You can set the default chunk options (and weave arguments) for a document using weave_options key in YAML Header Configuration. E.g. to set the default out_width of all figures you can use:
---
weave_options:
out_width : 50%
----You can also set or change the default chunk options for a document either before weave using the set_chunk_defaults function.
Weave.set_chunk_defaults! — Functionset_chunk_defaults!(opts::Dict{Symbol, Any})Set default options for code chunks, use get_chunk_defaults to see the current values.
E.g.: set default dpi to 200 and fig_width to 8
julia> set_chunk_defaults!(Dict(:dpi => 200, :fig_width => 8))Weave.get_chunk_defaults — Functionget_chunk_defaults()Get default options used for code chunks.
Weave.restore_chunk_defaults! — Functionrestore_chunk_defaults!()Restore Weave.jl default chunk options.