mirror of https://github.com/mpastell/Weave.jl
452 lines
16 KiB
HTML
452 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
|
||
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
|
||
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
|
||
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
|
||
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
|
||
|
||
|
||
<title>Chunk options - Weave.jl</title>
|
||
|
||
|
||
|
||
|
||
<meta name="author" content="Matti Pastell">
|
||
|
||
|
||
<meta property="og:url" content="None">
|
||
<meta property="og:title" content="Weave.jl">
|
||
<meta property="og:image" content="None/../">
|
||
<meta name="apple-mobile-web-app-title" content="Weave.jl">
|
||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
|
||
|
||
|
||
<link rel="shortcut icon" type="image/x-icon" href="../assets/images/favicon-e565ddfa3b.ico">
|
||
<link rel="icon" type="image/x-icon" href="../assets/images/favicon-e565ddfa3b.ico">
|
||
<style>
|
||
@font-face {
|
||
font-family: 'Icon';
|
||
src: url('../assets/fonts/icon.eot?52m981');
|
||
src: url('../assets/fonts/icon.eot?#iefix52m981')
|
||
format('embedded-opentype'),
|
||
url('../assets/fonts/icon.woff?52m981')
|
||
format('woff'),
|
||
url('../assets/fonts/icon.ttf?52m981')
|
||
format('truetype'),
|
||
url('../assets/fonts/icon.svg?52m981#icon')
|
||
format('svg');
|
||
font-weight: normal;
|
||
font-style: normal;
|
||
}
|
||
</style>
|
||
<link rel="stylesheet" href="../assets/stylesheets/application-a422ff04cc.css">
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu+Mono">
|
||
<style>
|
||
body, input {
|
||
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
|
||
}
|
||
pre, code {
|
||
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
|
||
}
|
||
</style>
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/Documenter.css">
|
||
|
||
<script src="../assets/javascripts/modernizr-4ab42b99fd.js"></script>
|
||
|
||
</head>
|
||
|
||
|
||
|
||
<body class=" ">
|
||
|
||
|
||
|
||
|
||
<div class="backdrop">
|
||
<div class="backdrop-paper"></div>
|
||
</div>
|
||
<input class="toggle" type="checkbox" id="toggle-drawer">
|
||
<input class="toggle" type="checkbox" id="toggle-search">
|
||
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
||
<header class="header">
|
||
<nav aria-label="Header">
|
||
<div class="bar default">
|
||
<div class="button button-menu" role="button" aria-label="Menu">
|
||
<label class="toggle-button icon icon-menu" for="toggle-drawer">
|
||
<span></span>
|
||
</label>
|
||
</div>
|
||
<div class="stretch">
|
||
<div class="title">
|
||
|
||
<span class="path">
|
||
|
||
</span>
|
||
|
||
Chunk options
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="button button-twitter" role="button" aria-label="Twitter">
|
||
<a href="https://twitter.com/mpastell" title="@mpastell on Twitter" target="_blank" class="toggle-button icon icon-twitter"></a>
|
||
</div>
|
||
|
||
|
||
<div class="button button-search" role="button" aria-label="Search">
|
||
<label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
|
||
</div>
|
||
</div>
|
||
<div class="bar search">
|
||
<div class="button button-close" role="button" aria-label="Close">
|
||
<label class="toggle-button icon icon-back" for="toggle-search"></label>
|
||
</div>
|
||
<div class="stretch">
|
||
<div class="field">
|
||
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
|
||
</div>
|
||
</div>
|
||
<div class="button button-reset" role="button" aria-label="Search">
|
||
<button class="toggle-button icon icon-close" id="reset-search"></button>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</header>
|
||
<main class="main">
|
||
|
||
<div class="drawer">
|
||
<nav aria-label="Navigation">
|
||
|
||
<a href="https://github.com/mpastell/Weave.jl" class="project">
|
||
<div class="banner">
|
||
|
||
<div class="name">
|
||
<strong>
|
||
Weave.jl
|
||
<span class="version">
|
||
v0.4.1
|
||
</span>
|
||
</strong>
|
||
|
||
<br>
|
||
mpastell/Weave.jl
|
||
|
||
</div>
|
||
</div>
|
||
</a>
|
||
<div class="scrollable">
|
||
<div class="wrapper">
|
||
|
||
<ul class="repo">
|
||
<li class="repo-download">
|
||
|
||
<a href="https://github.com/mpastell/Weave.jl/archive/v0.4.1.zip" target="_blank" title="Download" data-action="download">
|
||
<i class="icon icon-download"></i> Download
|
||
</a>
|
||
</li>
|
||
<li class="repo-stars">
|
||
<a href="https://github.com/mpastell/Weave.jl/stargazers" target="_blank" title="Stargazers" data-action="star">
|
||
<i class="icon icon-star"></i> Stars
|
||
<span class="count">–</span>
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
|
||
<div class="toc">
|
||
<ul>
|
||
|
||
|
||
<li>
|
||
<a class="" title="Home" href="..">
|
||
Home
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a class="" title="Getting started" href="../getting_started/">
|
||
Getting started
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a class="" title="Using Weave" href="../usage/">
|
||
Using Weave
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a class="" title="Publishing scripts" href="../publish/">
|
||
Publishing scripts
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a class="current" title="Chunk options" href="./">
|
||
Chunk options
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
<ul>
|
||
|
||
<li class="anchor">
|
||
<a title="Options for code" href="#options-for-code">
|
||
Options for code
|
||
</a>
|
||
</li>
|
||
|
||
<li class="anchor">
|
||
<a title="Options for figures" href="#options-for-figures">
|
||
Options for figures
|
||
</a>
|
||
</li>
|
||
|
||
<li class="anchor">
|
||
<a title="Set default chunk options" href="#set-default-chunk-options">
|
||
Set default chunk options
|
||
</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a class="" title="Working with Jupyter notebooks" href="../notebooks/">
|
||
Working with Jupyter notebooks
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
<li>
|
||
<a class="" title="Function index" href="../function_index/">
|
||
Function index
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
<hr>
|
||
<span class="section">The author</span>
|
||
<ul>
|
||
|
||
|
||
<li>
|
||
<a href="https://twitter.com/mpastell" target="_blank" title="@mpastell on Twitter">
|
||
@mpastell on Twitter
|
||
</a>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</div>
|
||
<article class="article">
|
||
<div class="wrapper">
|
||
|
||
<p><a id='Chunk-options-1'></a></p>
|
||
<h1 id="chunk-options">Chunk options</h1>
|
||
<p>I've mostly followed <a href="http://yihui.name/knitr/options">Knitr</a>'s naming for chunk options, but not all options are implemented.</p>
|
||
<p>Options are separated using ";" and need to be valid Julia expressions. Example: A code chunk that saves and displays a 12 cm wide image and hides the source code:</p>
|
||
<div class="code"><pre><span></span><span class="o"><<</span><span class="n">fig_width</span><span class="o">=</span><span class="mi">5</span><span class="p">;</span> <span class="n">echo</span><span class="o">=</span><span class="kc">false</span> <span class="o">>>=</span>
|
||
<span class="k">using</span> <span class="n">Gadfly</span>
|
||
<span class="n">x</span> <span class="o">=</span> <span class="n">linspace</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="nb">π</span><span class="p">,</span> <span class="mi">200</span><span class="p">)</span>
|
||
<span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="n">sin</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="n">Geom</span><span class="o">.</span><span class="n">line</span><span class="p">)</span>
|
||
<span class="err">@</span>
|
||
</pre></div>
|
||
|
||
|
||
<p>Weave currently supports the following chunk options with the following defaults:</p>
|
||
<p><a id='Options-for-code-1'></a></p>
|
||
<h2 id="options-for-code">Options for code</h2>
|
||
<ul>
|
||
<li><code>echo = true</code>. Echo the code in the output document. If <code>false</code> the source code will be hidden.</li>
|
||
<li><code>results = "markup"</code>. 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 wan’t to e.g. create tables from code chunks.</li>
|
||
<li><code>eval = true</code>. Evaluate the code chunk. If false the chunk won’t be executed.</li>
|
||
<li><code>term=false</code>. If true the output emulates a REPL session. Otherwise only stdout and figures will be included in output.</li>
|
||
<li><code>label</code>. Chunk label, will be used for figure labels in Latex as fig:label</li>
|
||
<li><code>wrap = true</code>. Wrap long lines from output.</li>
|
||
<li><code>line_width = 75</code>. Line width for wrapped lines.</li>
|
||
<li><code>cache = false</code>. Cache results, depends on <code>cache</code> parameter on <code>weave</code> function.</li>
|
||
<li><code>hold = false</code>. Hold all results until the end of the chunk.</li>
|
||
<li><code>tangle = true</code>. Set tangle to false to exclude chunk from tangled code.</li>
|
||
</ul>
|
||
<p><a id='Options-for-figures-1'></a></p>
|
||
<h2 id="options-for-figures">Options for figures</h2>
|
||
<ul>
|
||
<li><code>fig_width</code>. Figure width defined in markup, default depends on the output format.</li>
|
||
<li><code>out_width</code>. Width of saved figure.</li>
|
||
<li><code>out_height</code>. Height of saved figure.</li>
|
||
<li><code>dpi</code>=96. Resolution of saved figures.</li>
|
||
<li><code>fig_cap</code>. Figure caption.</li>
|
||
<li><code>label</code>. Chunk label, will be used for figure labels in Latex as fig:label</li>
|
||
<li><code>fig_ext</code>. File extension (format) of saved figures.</li>
|
||
<li><code>fig_pos="htpb"</code>. Figure position in Latex.</li>
|
||
<li><code>fig_env="figure"</code>. Figure environment in Latex.</li>
|
||
</ul>
|
||
<p><a id='Set-default-chunk-options-1'></a></p>
|
||
<h2 id="set-default-chunk-options">Set default chunk options</h2>
|
||
<p>You can set or alter the default chunk options for a document either before running weave or inside the weaved document. You can e.g. use a hidden chunk in the beginning of the source document to set the options:</p>
|
||
<div class="code"><pre><span></span><span class="o"><<</span><span class="n">echo</span> <span class="o">=</span> <span class="kc">false</span><span class="o">>>=</span>
|
||
<span class="k">import</span> <span class="n">Weave</span>
|
||
<span class="n">Weave</span><span class="o">.</span><span class="n">set_chunk_defaults</span><span class="p">(</span><span class="kt">Dict</span><span class="p">{</span><span class="kt">Symbol</span><span class="p">,</span> <span class="kt">Any</span><span class="p">}(</span>
|
||
<span class="o">:</span><span class="n">out_width</span> <span class="o">=></span> <span class="s">"</span><span class="se">\\</span><span class="s">0.5linewidth"</span><span class="p">,</span>
|
||
<span class="o">:</span><span class="n">results</span> <span class="o">=></span> <span class="s">"tex"</span>
|
||
<span class="p">))</span>
|
||
<span class="err">@</span>
|
||
</pre></div>
|
||
|
||
|
||
<div class="code"><pre><span></span>set_chunk_defaults(opts)
|
||
get_chunk_defaults()
|
||
restore_chunk_defaults()
|
||
</pre></div>
|
||
<aside class="copyright" role="note">
|
||
|
||
Matti Pastell 2016 –
|
||
|
||
Documentation built with
|
||
<a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
|
||
using the
|
||
<a href="http://squidfunk.github.io/mkdocs-material/" target="_blank">
|
||
Material
|
||
</a>
|
||
theme.
|
||
</aside>
|
||
|
||
<footer class="footer">
|
||
|
||
<nav class="pagination" aria-label="Footer">
|
||
<div class="previous">
|
||
|
||
<a href="../publish/" title="Publishing scripts">
|
||
<span class="direction">
|
||
Previous
|
||
</span>
|
||
<div class="page">
|
||
<div class="button button-previous" role="button" aria-label="Previous">
|
||
<i class="icon icon-back"></i>
|
||
</div>
|
||
<div class="stretch">
|
||
<div class="title">
|
||
Publishing scripts
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
</div>
|
||
<div class="next">
|
||
|
||
<a href="../notebooks/" title="Working with Jupyter notebooks">
|
||
<span class="direction">
|
||
Next
|
||
</span>
|
||
<div class="page">
|
||
<div class="stretch">
|
||
<div class="title">
|
||
Working with Jupyter notebooks
|
||
</div>
|
||
</div>
|
||
<div class="button button-next" role="button" aria-label="Next">
|
||
<i class="icon icon-forward"></i>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
</div>
|
||
</nav>
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</article>
|
||
<div class="results" role="status" aria-live="polite">
|
||
<div class="scrollable">
|
||
<div class="wrapper">
|
||
<div class="meta"></div>
|
||
<div class="list"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</main>
|
||
<script>
|
||
var base_url = '..';
|
||
var repo_id = 'mpastell/Weave.jl';
|
||
</script>
|
||
<script src="../assets/javascripts/application-997097ee0c.js"></script>
|
||
|
||
<script src="../assets/mathjaxhelper.js"></script>
|
||
|
||
|
||
<script>
|
||
(function(i,s,o,g,r,a,m){
|
||
i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||
|
||
[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
|
||
m.parentNode.insertBefore(a,m)
|
||
})(window, document,
|
||
'script', 'https://www.google-analytics.com/analytics.js', 'ga');
|
||
/* General initialization */
|
||
ga('create', 'UA-6474352-10', 'auto');
|
||
ga('set', 'anonymizeIp', true);
|
||
ga('send', 'pageview');
|
||
/* Track outbound links */
|
||
var buttons = document.querySelectorAll('a');
|
||
Array.prototype.map.call(buttons, function(item) {
|
||
if (item.host != document.location.host) {
|
||
item.addEventListener('click', function() {
|
||
var action = item.getAttribute('data-action') || 'follow';
|
||
ga('send', 'event', 'outbound', action, item.href);
|
||
});
|
||
}
|
||
});
|
||
/* Register handler to log search on blur */
|
||
var query = document.querySelector('.query');
|
||
query.addEventListener('blur', function() {
|
||
if (this.value) {
|
||
var path = document.location.pathname;
|
||
ga('send', 'pageview', path + '?q=' + this.value);
|
||
}
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |