mirror of https://github.com/mpastell/Weave.jl
415 lines
12 KiB
HTML
415 lines
12 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>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>
|
|
|
|
Weave.jl
|
|
</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="current" title="Home" href=".">
|
|
Home
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
<li class="anchor">
|
|
<a title="Contents" href="#contents">
|
|
Contents
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</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="" title="Chunk options" href="chunk_options/">
|
|
Chunk options
|
|
</a>
|
|
|
|
</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='Weave.jl-Scientific-Reports-Using-Julia-1'></a></p>
|
|
<h1 id="weavejl-scientific-reports-using-julia">Weave.jl - Scientific Reports Using Julia</h1>
|
|
<p>This is the documentation of <a href="http://github.com/mpastell/weave.jl">Weave.jl</a>. Weave is a scientific report generator/literate programming tool for Julia. It resembles <a href="http://mpastell.com/pweave">Pweave</a>, Knitr, rmarkdown and Sweave.</p>
|
|
<p><strong>Current features</strong></p>
|
|
<ul>
|
|
<li>Noweb, markdown or script syntax for input documents.</li>
|
|
<li>Execute code as terminal or "script" chunks.</li>
|
|
<li>Capture Plots, Gadfly and PyPlot figures.</li>
|
|
<li>Supports LaTex, Pandoc, Github markdown, MultiMarkdown, Asciidoc and reStructuredText output</li>
|
|
<li>Publish markdown directly to html and pdf using julia or Pandoc markdown.</li>
|
|
<li>Simple caching of results</li>
|
|
<li>Convert to and from IJulia notebooks</li>
|
|
</ul>
|
|
<p><img alt="Weave code and output" src="http://mpastell.com/images/weave_demo.png" /></p>
|
|
<p><a id='Contents-1'></a></p>
|
|
<h2 id="contents">Contents</h2>
|
|
<ul>
|
|
<li><a href="getting_started/#Getting-started-1">Getting started</a></li>
|
|
<li><a href="usage/#Using-Weave-1">Using Weave</a><ul>
|
|
<li><a href="usage/#Weave-1">Weave</a></li>
|
|
<li><a href="usage/#Weave-from-shell-1">Weave from shell</a></li>
|
|
<li><a href="usage/#Tangle-1">Tangle</a></li>
|
|
<li><a href="usage/#Supported-formats-1">Supported formats</a></li>
|
|
<li><a href="usage/#Document-syntax-1">Document syntax</a></li>
|
|
<li><a href="usage/#Noweb-format-1">Noweb format</a></li>
|
|
<li><a href="usage/#Markdown-format-1">Markdown format</a></li>
|
|
<li><a href="usage/#Script-format-1">Script format</a></li>
|
|
<li><a href="usage/#Inline-code-1">Inline code</a></li>
|
|
<li><a href="usage/#Passing-arguments-to-documents-1">Passing arguments to documents</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="publish/#Publishing-to-html-and-pdf-1">Publishing to html and pdf</a><ul>
|
|
<li><a href="publish/#Templates-1">Templates</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="chunk_options/#Chunk-options-1">Chunk options</a><ul>
|
|
<li><a href="chunk_options/#Options-for-code-1">Options for code</a></li>
|
|
<li><a href="chunk_options/#Options-for-figures-1">Options for figures</a></li>
|
|
<li><a href="chunk_options/#Set-default-chunk-options-1">Set default chunk options</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="notebooks/#Working-with-Jupyter-notebooks-1">Working with Jupyter notebooks</a><ul>
|
|
<li><a href="notebooks/#Weaving-1">Weaving</a></li>
|
|
<li><a href="notebooks/#Converting-between-formats-1">Converting between formats</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="function_index/#Function-index-1">Function index</a></li>
|
|
</ul>
|
|
<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">
|
|
|
|
</div>
|
|
<div class="next">
|
|
|
|
<a href="getting_started/" title="Getting started">
|
|
<span class="direction">
|
|
Next
|
|
</span>
|
|
<div class="page">
|
|
<div class="stretch">
|
|
<div class="title">
|
|
Getting started
|
|
</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> |