|
a |
|
b/docs/index.html |
|
|
1 |
<!DOCTYPE html> |
|
|
2 |
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
|
|
5 |
<meta charset="utf-8"> |
|
|
6 |
<meta http-equiv="X-UA-Compatible" content="IE=edge"> |
|
|
7 |
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
|
|
8 |
<title>Bayesian Reconstruction of Disease Outbreaks by Combining Epidemiologic |
|
|
9 |
and Genomic Data • outbreaker2</title> |
|
|
10 |
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"> |
|
|
11 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="bootstrap-toc.css"> |
|
|
12 |
<script src="bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"> |
|
|
13 |
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"> |
|
|
14 |
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet"> |
|
|
15 |
<script src="pkgdown.js"></script><meta property="og:title" content="Bayesian Reconstruction of Disease Outbreaks by Combining Epidemiologic |
|
|
16 |
and Genomic Data"> |
|
|
17 |
<meta property="og:description" content="Bayesian reconstruction of disease outbreaks using epidemiological |
|
|
18 |
and genetic information. Jombart T, Cori A, Didelot X, Cauchemez S, Fraser |
|
|
19 |
C and Ferguson N. 2014. <doi:10.1371/journal.pcbi.1003457>. Campbell, F, |
|
|
20 |
Cori A, Ferguson N, Jombart T. 2019. <doi:10.1371/journal.pcbi.1006930>."> |
|
|
21 |
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> |
|
|
22 |
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> |
|
|
23 |
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
|
|
24 |
<![endif]--> |
|
|
25 |
</head> |
|
|
26 |
<body data-spy="scroll" data-target="#toc"> |
|
|
27 |
<div class="container template-home"> |
|
|
28 |
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> |
|
|
29 |
<div class="container"> |
|
|
30 |
<div class="navbar-header"> |
|
|
31 |
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> |
|
|
32 |
<span class="sr-only">Toggle navigation</span> |
|
|
33 |
<span class="icon-bar"></span> |
|
|
34 |
<span class="icon-bar"></span> |
|
|
35 |
<span class="icon-bar"></span> |
|
|
36 |
</button> |
|
|
37 |
<span class="navbar-brand"> |
|
|
38 |
<a class="navbar-link" href="index.html">outbreaker2</a> |
|
|
39 |
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.2</span> |
|
|
40 |
</span> |
|
|
41 |
</div> |
|
|
42 |
|
|
|
43 |
<div id="navbar" class="navbar-collapse collapse"> |
|
|
44 |
<ul class="nav navbar-nav"> |
|
|
45 |
<li> |
|
|
46 |
<a href="index.html"> |
|
|
47 |
<span class="fas fa-home fa-lg"></span> |
|
|
48 |
|
|
|
49 |
</a> |
|
|
50 |
</li> |
|
|
51 |
<li> |
|
|
52 |
<a href="reference/index.html">Reference</a> |
|
|
53 |
</li> |
|
|
54 |
<li class="dropdown"> |
|
|
55 |
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"> |
|
|
56 |
Articles |
|
|
57 |
|
|
|
58 |
<span class="caret"></span> |
|
|
59 |
</a> |
|
|
60 |
<ul class="dropdown-menu" role="menu"> |
|
|
61 |
<li> |
|
|
62 |
<a href="articles/customisation.html">Using custom priors, likelihood, or movements in outbreaker2</a> |
|
|
63 |
</li> |
|
|
64 |
<li> |
|
|
65 |
<a href="articles/introduction.html">Introduction to outbreaker2</a> |
|
|
66 |
</li> |
|
|
67 |
<li> |
|
|
68 |
<a href="articles/overview.html">outbreaker2: package overview</a> |
|
|
69 |
</li> |
|
|
70 |
<li> |
|
|
71 |
<a href="articles/Rcpp_API.html">outbreaker2: Rcpp API</a> |
|
|
72 |
</li> |
|
|
73 |
</ul> |
|
|
74 |
</li> |
|
|
75 |
<li> |
|
|
76 |
<a href="news/index.html">Changelog</a> |
|
|
77 |
</li> |
|
|
78 |
</ul> |
|
|
79 |
<ul class="nav navbar-nav navbar-right"></ul> |
|
|
80 |
</div> |
|
|
81 |
<!--/.nav-collapse --> |
|
|
82 |
</div> |
|
|
83 |
<!--/.container --> |
|
|
84 |
</div> |
|
|
85 |
<!--/.navbar --> |
|
|
86 |
|
|
|
87 |
|
|
|
88 |
|
|
|
89 |
</header><div class="row"> |
|
|
90 |
<div class="contents col-md-9"> |
|
|
91 |
|
|
|
92 |
|
|
|
93 |
<div id="outbreaker2-a-framework-for-reconstructing-disease-outbreaks" class="section level2"> |
|
|
94 |
<h2 class="hasAnchor"> |
|
|
95 |
<a href="#outbreaker2-a-framework-for-reconstructing-disease-outbreaks" class="anchor"></a><em>outbreaker2: a framework for reconstructing disease outbreaks</em> |
|
|
96 |
</h2> |
|
|
97 |
<p>Welcome to the project page of <em>outbreaker2</em>, a Bayesian framework for integrating epidemiological and genetic data to reconstruct transmission trees of densely sampled outbreaks. It re-implements, generalises and replaces the model of <a href="https://github.com/thibautjombart/outbreaker"><em>outbreaker</em></a>, and uses a modular approach which enables fine customisation of priors, likelihoods and parameter movements (see <a href="http://www.repidemicsconsortium.org/outbreaker2/articles/customisation.html">customisation vignette</a>).</p> |
|
|
98 |
<div id="note-correction-to-genetic-likelihood" class="section level3"> |
|
|
99 |
<h3 class="hasAnchor"> |
|
|
100 |
<a href="#note-correction-to-genetic-likelihood" class="anchor"></a>NOTE: Correction to genetic likelihood</h3> |
|
|
101 |
<p>The genetic likelihood of the <a href="https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1003457">original <em>outbreaker</em> paper</a> was found to contain a minor mistake in accounting for unobserved generations of infection. As of June 7th 2019, <em>outbreaker2</em> will use the correct genetic likelihood published <a href="https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1006930">here</a>.</p> |
|
|
102 |
<p>The original genetic likelihood was:</p> |
|
|
103 |
<p><img src="https://latex.codecogs.com/svg.latex?%5Cmu%5E%7Bd(s_i,s_%7B%5Calpha_i%7D)%7D(1&space;-&space;%5Cmu)%5E%7B(%5Ckappa_i%5Ctimes&space;l(s_i,&space;s_%7B%5Calpha_i%7D))&space;-&space;d(s_i,s_%7B%5Calpha_i%7D)%7D" title="\mu^{d(s_i,s_{\alpha_i})}(1 - \mu)^{(\kappa_i\times l(s_i, s_{\alpha_i})) - d(s_i,s_{\alpha_i})}"></p> |
|
|
104 |
<p>The corrected genetic likelihood is:</p> |
|
|
105 |
<p><img src="https://latex.codecogs.com/svg.latex?(%5Ckappa_i&space;%5Cmu)%5E%7Bd(s_i,s_%7B%5Calpha_i%7D)%7D(1&space;-&space;%5Ckappa_i&space;%5Cmu)%5E%7Bl(s_i,&space;s_%7B%5Calpha_i%7D)&space;-&space;d(s_i,s_%7B%5Calpha_i%7D)%7D" title="(\kappa_i \mu)^{d(s_i,s_{\alpha_i})}(1 - \mu)^{(\kappa_i\times l(s_i, s_{\alpha_i})) - d(s_i,s_{\alpha_i})}"></p> |
|
|
106 |
<p><br></p> |
|
|
107 |
</div> |
|
|
108 |
</div> |
|
|
109 |
<div id="installation" class="section level2"> |
|
|
110 |
<h2 class="hasAnchor"> |
|
|
111 |
<a href="#installation" class="anchor"></a>Installation</h2> |
|
|
112 |
<p>To install the stable version from CRAN:</p> |
|
|
113 |
<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> |
|
|
114 |
<code class="sourceCode R"><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html">install.packages</a></span><span class="op">(</span><span class="st">"outbreaker2"</span><span class="op">)</span></code></pre></div> |
|
|
115 |
<p>To install the development version from github (requires Rtools on windows and GSL headers on all platforms):</p> |
|
|
116 |
<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r"> |
|
|
117 |
<code class="sourceCode R"><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://devtools.r-lib.org//reference/remote-reexports.html">install_github</a></span><span class="op">(</span><span class="st">"reconhub/outbreaker2"</span><span class="op">)</span></code></pre></div> |
|
|
118 |
<p>To add local copies of the vignettes, you will need to specify:</p> |
|
|
119 |
<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r"> |
|
|
120 |
<code class="sourceCode R"><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://devtools.r-lib.org//reference/remote-reexports.html">install_github</a></span><span class="op">(</span><span class="st">"reconhub/outbreaker2"</span>, build_vignettes <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div> |
|
|
121 |
<p>Then, to load the package, use:</p> |
|
|
122 |
<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r"> |
|
|
123 |
<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span><span class="op">(</span><span class="st">"outbreaker2"</span><span class="op">)</span></code></pre></div> |
|
|
124 |
<p><br></p> |
|
|
125 |
</div> |
|
|
126 |
<div id="documentation" class="section level2"> |
|
|
127 |
<h2 class="hasAnchor"> |
|
|
128 |
<a href="#documentation" class="anchor"></a>Documentation</h2> |
|
|
129 |
<p><em>outbreaker2</em> is fully documented on a <a href="http://www.repidemicsconsortium.org/outbreaker2/">dedicated website</a>.</p> |
|
|
130 |
<p>It also comes with the following vignettes:</p> |
|
|
131 |
<ul> |
|
|
132 |
<li> |
|
|
133 |
<strong><code>introduction</code></strong>: general introduction using a worked example.</li> |
|
|
134 |
<li> |
|
|
135 |
<strong><code>overview</code></strong>: brief overview of the package’s content.</li> |
|
|
136 |
<li> |
|
|
137 |
<strong><code>customisation</code></strong>: customisation of priors, likelihoods, and movement functions.</li> |
|
|
138 |
<li> |
|
|
139 |
<strong><code>Rcpp_API</code></strong>: documentation for the Rcpp API.</li> |
|
|
140 |
</ul> |
|
|
141 |
<p><br></p> |
|
|
142 |
</div> |
|
|
143 |
<div id="contributors" class="section level2"> |
|
|
144 |
<h2 class="hasAnchor"> |
|
|
145 |
<a href="#contributors" class="anchor"></a>Contributors</h2> |
|
|
146 |
<ul> |
|
|
147 |
<li><a href="https://github.com/thibautjombart">Thibaut Jombart</a></li> |
|
|
148 |
<li><a href="https://github.com/finlaycampbell">Finlay Campbell</a></li> |
|
|
149 |
<li><a href="https://github.com/richfitz">Rich Fitzjohn</a></li> |
|
|
150 |
<li><a href="https://github.com/gtonkinhill">Gerry Tonkin-Hill</a></li> |
|
|
151 |
<li><a href="https://github.com/alxsrobert">Alexis Robert</a></li> |
|
|
152 |
<li><a href="https://github.com/kreldjarn">Kristjan Eldjarn</a></li> |
|
|
153 |
</ul> |
|
|
154 |
<p>See details of contributions <a href="https://github.com/reconhub/outbreaker2/graphs/contributors">here</a>.</p> |
|
|
155 |
<p>Contributions are welcome via <strong>pull requests</strong>.</p> |
|
|
156 |
<p>Please note that this project is released with a <a href="https://github.com/reconhub/outbreaker2/blob/master/CONDUCT.md">Contributor Code of Conduct</a>. By participating in this project you agree to abide by its terms.</p> |
|
|
157 |
<p><strong>Maintainer:</strong> Finlay Campbell (<a href="mailto:finlaycampbell93@gmail.com" class="email">finlaycampbell93@gmail.com</a>)</p> |
|
|
158 |
</div> |
|
|
159 |
|
|
|
160 |
</div> |
|
|
161 |
|
|
|
162 |
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> |
|
|
163 |
<div class="links"> |
|
|
164 |
<h2>Links</h2> |
|
|
165 |
<ul class="list-unstyled"> |
|
|
166 |
<li>Download from CRAN at <br><a href="https://cloud.r-project.org/package=outbreaker2">https://cloud.r-project.org/package=outbreaker2</a> |
|
|
167 |
</li> |
|
|
168 |
</ul> |
|
|
169 |
</div> |
|
|
170 |
<div class="license"> |
|
|
171 |
<h2>License</h2> |
|
|
172 |
<ul class="list-unstyled"> |
|
|
173 |
<li> |
|
|
174 |
<a href="https://opensource.org/licenses/mit-license.php">MIT</a> + file <a href="LICENSE-text.html">LICENSE</a> |
|
|
175 |
</li> |
|
|
176 |
</ul> |
|
|
177 |
</div> |
|
|
178 |
<div class="citation"> |
|
|
179 |
<h2>Citation</h2> |
|
|
180 |
<ul class="list-unstyled"> |
|
|
181 |
<li><a href="authors.html">Citing outbreaker2</a></li> |
|
|
182 |
</ul> |
|
|
183 |
</div> |
|
|
184 |
<div class="developers"> |
|
|
185 |
<h2>Developers</h2> |
|
|
186 |
<ul class="list-unstyled"> |
|
|
187 |
<li>Thibaut Jombart <br><small class="roles"> Author </small> </li> |
|
|
188 |
<li>Finlay Campbell <br><small class="roles"> Author, maintainer </small> </li> |
|
|
189 |
<li>Rich Fitzjohn <br><small class="roles"> Author </small> </li> |
|
|
190 |
<li><a href="authors.html">All authors...</a></li> |
|
|
191 |
</ul> |
|
|
192 |
</div> |
|
|
193 |
|
|
|
194 |
<div class="dev-status"> |
|
|
195 |
<h2>Dev status</h2> |
|
|
196 |
<ul class="list-unstyled"> |
|
|
197 |
<li><a href="https://travis-ci.org/reconhub/outbreaker2"><img src="https://travis-ci.org/reconhub/outbreaker2.svg?branch=master" alt="Travis-CI Build Status"></a></li> |
|
|
198 |
<li><a href="https://ci.appveyor.com/project/thibautjombart/outbreaker2/branch/master"><img src="https://ci.appveyor.com/api/projects/status/yj449x0yqhphvcrt/branch/master?svg=true" alt="Appveyor build status"></a></li> |
|
|
199 |
<li><a href="https://codecov.io/github/reconhub/outbreaker2?branch=master"><img src="https://codecov.io/github/reconhub/outbreaker2/coverage.svg?branch=master" alt="Coverage Status"></a></li> |
|
|
200 |
<li><a href="https://cran.r-project.org/package=outbreaker2"><img src="https://cranlogs.r-pkg.org/badges/outbreaker2" alt="CRAN Downloads"></a></li> |
|
|
201 |
<li><a href="https://www.r-pkg.org:443/pkg/outbreaker2"><img src="https://cranlogs.r-pkg.org/badges/grand-total/outbreaker2" alt="Downloads from Rstudio mirror"></a></li> |
|
|
202 |
<li><a href="https://cran.r-project.org/package=outbreaker2"><img src="https://www.r-pkg.org/badges/version/outbreaker2" alt="CRAN_Status_Badge"></a></li> |
|
|
203 |
</ul> |
|
|
204 |
</div> |
|
|
205 |
</div> |
|
|
206 |
</div> |
|
|
207 |
|
|
|
208 |
|
|
|
209 |
<footer><div class="copyright"> |
|
|
210 |
<p>Developed by Thibaut Jombart, Finlay Campbell, Rich Fitzjohn.</p> |
|
|
211 |
</div> |
|
|
212 |
|
|
|
213 |
<div class="pkgdown"> |
|
|
214 |
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p> |
|
|
215 |
</div> |
|
|
216 |
|
|
|
217 |
</footer> |
|
|
218 |
</div> |
|
|
219 |
|
|
|
220 |
|
|
|
221 |
|
|
|
222 |
|
|
|
223 |
</body> |
|
|
224 |
</html> |