outbreaker2 / Git / Diff of /docs/reference/get_cpp

Models:
MarcoTheBlack/
outbreaker2
Downloads: 1
Diff of /docs/reference/get_cpp_api.html [000000] .. [dfe06d]
Switch to side-by-side view

--- a
+++ b/docs/reference/get_cpp_api.html
@@ -0,0 +1,242 @@
+<!-- Generated by pkgdown: do not edit by hand -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+  <meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<title>Access internal C++ rountines used in outbreaker2 — get_cpp_api • outbreaker2</title>
+
+
+<!-- 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" />
+
+<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">
+<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" />
+<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" />
+
+<!-- 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">
+<script src="../pkgdown.js"></script>
+
+
+
+
+<meta property="og:title" content="Access internal C++ rountines used in outbreaker2 — get_cpp_api" />
+<meta property="og:description" content="This function returns an environment containing all C++ functions (bound to R
+using Rcpp) used for priors, likelihoods, and movements of parameters in
+outbreaker2." />
+
+
+
+
+<!-- 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]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+<![endif]-->
+
+
+
+  </head>
+
+  <body data-spy="scroll" data-target="#toc">
+    <div class="container template-reference-topic">
+      <header>
+      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <span class="navbar-brand">
+        <a class="navbar-link" href="../index.html">outbreaker2</a>
+        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.2</span>
+      </span>
+    </div>
+
+    <div id="navbar" class="navbar-collapse collapse">
+      <ul class="nav navbar-nav">
+        <li>
+  <a href="../index.html">
+    <span class="fas fa-home fa-lg"></span>
+     
+  </a>
+</li>
+<li>
+  <a href="../reference/index.html">Reference</a>
+</li>
+<li class="dropdown">
+  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
+    Articles
+     
+    <span class="caret"></span>
+  </a>
+  <ul class="dropdown-menu" role="menu">
+    <li>
+      <a href="../articles/customisation.html">Using custom priors, likelihood, or movements in outbreaker2</a>
+    </li>
+    <li>
+      <a href="../articles/introduction.html">Introduction to outbreaker2</a>
+    </li>
+    <li>
+      <a href="../articles/overview.html">outbreaker2: package overview</a>
+    </li>
+    <li>
+      <a href="../articles/Rcpp_API.html">outbreaker2: Rcpp API</a>
+    </li>
+  </ul>
+</li>
+<li>
+  <a href="../news/index.html">Changelog</a>
+</li>
+      </ul>
+      <ul class="nav navbar-nav navbar-right">
+        
+      </ul>
+      
+    </div><!--/.nav-collapse -->
+  </div><!--/.container -->
+</div><!--/.navbar -->
+
+      
+
+      </header>
+
+<div class="row">
+  <div class="col-md-9 contents">
+    <div class="page-header">
+    <h1>Access internal C++ rountines used in outbreaker2</h1>
+    
+    <div class="hidden name"><code>get_cpp_api.Rd</code></div>
+    </div>
+
+    <div class="ref-description">
+    <p>This function returns an environment containing all C++ functions (bound to R
+using Rcpp) used for priors, likelihoods, and movements of parameters in
+outbreaker2.</p>
+    </div>
+
+    <pre class="usage"><span class='fu'>get_cpp_api</span><span class='op'>(</span><span class='op'>)</span></pre>
+
+
+    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
+
+    <p>An environment containing Rcpp bindings to C++ functions used internally in
+outbreaker2. All functions are named as cpp_[type]_[component], where 'type'
+can be:</p>
+<ul>
+<li><p>'prior': prior computation</p></li>
+<li><p>'ll':  likelihood computation</p></li>
+<li><p>'move': movement of parameters or augmented data</p></li>
+</ul>
+
+<p>And where 'component' can be:</p>
+<ul>
+<li><p>'mu': (parameter) mutation rate</p></li>
+<li><p>'pi': (parameter) reporting probability</p></li>
+<li><p>'lambda': (parameter) non-infectious contact rate</p></li>
+<li><p>'eps': (parameter) contact reporting coverage</p></li>
+<li><p>'alpha': (augmented data) ancestries of the cases</p></li>
+<li><p>'kappa': (augmented data) generation between cases on transmission
+chains</p></li>
+<li><p>'t_inf': (augmented data) dates of infections</p></li>
+<li><p>'timing_infections': (likelihood component) timing between infectors and
+infectees</p></li>
+<li><p>'timing_sampling': (likelihood component) timing between infection and
+reporting / isolation</p></li>
+<li><p>'timing': (likelihood component) sum of the two timing components</p></li>
+<li><p>'genetic': (likelihood component) genetic diversity accumulated along
+transmission chains</p></li>
+<li><p>'reporting': (likelihood component) reporting of cases</p></li>
+<li><p>'all': (likelihood component) sum of all likelihood components</p></li>
+<li><p>'swap_cases': (type of movement) swap infectors and infectees on a
+transmission tree</p></li>
+</ul>
+
+<p>For a description of the arguments of these functions, see the Rcpp_API
+vignette (<code><a href='../articles/Rcpp_API.html'>vignette("Rcpp_API", package = "outbreaker2")</a></code>).</p>
+    <h2 class="hasAnchor" id="author"><a class="anchor" href="#author"></a>Author</h2>
+
+    <p>Thibaut Jombart (<a href='mailto:thibautjombart@gmail.com'>thibautjombart@gmail.com</a>)</p>
+
+    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
+    <pre class="examples"><div class='input'>
+<span class='co'>## get functions in an environment</span>
+<span class='va'>api</span> <span class='op'>&lt;-</span> <span class='fu'>get_cpp_api</span><span class='op'>(</span><span class='op'>)</span>
+<span class='va'>api</span>
+</div><div class='output co'>#&gt; &lt;environment: 0x000000003a142060&gt;</div><div class='input'>
+<span class='co'>## check content of the environment</span>
+<span class='fu'><a href='https://rdrr.io/r/base/ls.html'>ls</a></span><span class='op'>(</span><span class='va'>api</span><span class='op'>)</span>
+</div><div class='output co'>#&gt;  [1] "cpp_ll_all"               "cpp_ll_contact"          
+#&gt;  [3] "cpp_ll_genetic"           "cpp_ll_reporting"        
+#&gt;  [5] "cpp_ll_timing"            "cpp_ll_timing_infections"
+#&gt;  [7] "cpp_ll_timing_sampling"   "cpp_move_alpha"          
+#&gt;  [9] "cpp_move_eps"             "cpp_move_kappa"          
+#&gt; [11] "cpp_move_lambda"          "cpp_move_mu"             
+#&gt; [13] "cpp_move_pi"              "cpp_move_swap_cases"     
+#&gt; [15] "cpp_move_t_inf"           "cpp_prior_all"           
+#&gt; [17] "cpp_prior_eps"            "cpp_prior_lambda"        
+#&gt; [19] "cpp_prior_mu"             "cpp_prior_pi"            </div><div class='input'>
+<span class='co'>## test the prior for mu</span>
+<span class='fu'><a href='https://rdrr.io/r/base/args.html'>args</a></span><span class='op'>(</span><span class='va'>api</span><span class='op'>$</span><span class='va'>cpp_prior_mu</span><span class='op'>)</span>
+</div><div class='output co'>#&gt; function (param, config, custom_function = NULL) 
+#&gt; NULL</div><div class='input'>
+<span class='va'>config</span> <span class='op'>&lt;-</span> <span class='fu'><a href='create_config.html'>create_config</a></span><span class='op'>(</span><span class='op'>)</span>
+
+<span class='va'>api</span><span class='op'>$</span><span class='fu'>cpp_prior_mu</span><span class='op'>(</span><span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></span><span class='op'>(</span>mu <span class='op'>=</span> <span class='fl'>0.00123</span><span class='op'>)</span>, <span class='va'>config</span><span class='op'>)</span>
+</div><div class='output co'>#&gt; [1] -0.00123</div><div class='input'>
+<span class='fu'><a href='https://rdrr.io/r/stats/Exponential.html'>dexp</a></span><span class='op'>(</span><span class='fl'>0.00123</span>, rate <span class='op'>=</span> <span class='va'>config</span><span class='op'>$</span><span class='va'>prior_mu</span>, log <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span>
+</div><div class='output co'>#&gt; [1] -0.00123</div><div class='input'>
+</div></pre>
+  </div>
+  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
+    <nav id="toc" data-toggle="toc" class="sticky-top">
+      <h2 data-toc-skip>Contents</h2>
+    </nav>
+  </div>
+</div>
+
+
+      <footer>
+      <div class="copyright">
+  <p>Developed by Thibaut Jombart, Finlay Campbell, Rich Fitzjohn.</p>
+</div>
+
+<div class="pkgdown">
+  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
+</div>
+
+      </footer>
+   </div>
+
+  
+
+
+  </body>
+</html>
+
+