Added navbar and removed insert_navbar.sh

v2.12.0/index.html

@@ -457,5 +457,6 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.png" alt="TuringGLM.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>TuringGLM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Getting-Started"><span>Getting Started</span></a></li><li><a class="tocitem" href="#Tutorials"><span>Tutorials</span></a></li></ul></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="tutorials/linear_regression/">Linear Regression</a></li><li><a class="tocitem" href="tutorials/logistic_regression/">Logistic Regression</a></li><li><a class="tocitem" href="tutorials/poisson_regression/">Poisson Regression</a></li><li><a class="tocitem" href="tutorials/negative_binomial_regression/">Negative Binomial Regression</a></li><li><a class="tocitem" href="tutorials/robust_regression/">Robust Regression</a></li><li><a class="tocitem" href="tutorials/hierarchical_models/">Hierarchical Models</a></li><li><a class="tocitem" href="tutorials/custom_priors/">Custom Priors</a></li></ul></li><li><a class="tocitem" href="api/">API reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="TuringGLM"><a class="docs-heading-anchor" href="#TuringGLM">TuringGLM</a><a id="TuringGLM-1"></a><a class="docs-heading-anchor-permalink" href="#TuringGLM" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/TuringLang/TuringGLM.jl"><code>TuringGLM</code></a>. Please <a href="https://github.com/TuringLang/TuringGLM.jl/issues/new">file an issue</a> if you run into any problems.</p><p><code>TuringGLM</code> supports Julia version 1.7+. We recommend always using it with the latest stable Julia release.</p><h2 id="Getting-Started"><a class="docs-heading-anchor" href="#Getting-Started">Getting Started</a><a id="Getting-Started-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-Started" title="Permalink"></a></h2><p>TuringGLM makes easy to specify Bayesian <strong>G</strong>eneralized <strong>L</strong>inear <strong>M</strong>odels using the formula syntax and returns an instantiated <a href="https://github.com/TuringLang/Turing.jl">Turing</a> model.</p><p>Heavily inspired by <a href="https://github.com/paul-buerkner/brms/">brms</a> (uses RStan or CmdStanR) and <a href="https://github.com/bambinos/bambi/">bambi</a> (uses PyMC3).</p><h3 id="@formula"><a class="docs-heading-anchor" href="#@formula"><code>@formula</code></a><a id="@formula-1"></a><a class="docs-heading-anchor-permalink" href="#@formula" title="Permalink"></a></h3><p>The <code>@formula</code> macro is extended from <a href="https://github.com/JuliaStats/StatsModels.jl"><code>StatsModels.jl</code></a> along with  <a href="https://github.com/JuliaStats/MixedModels.jl"><code>MixedModels.jl</code></a> for the random-effects (a.k.a. group-level predictors).</p><p>The syntax is done by using the <code>@formula</code> macro and then specifying the dependent variable followed by a tilde <code>~</code> then the independent variables separated by a plus sign <code>+</code>.</p><p>Example:</p><pre><code class="language-julia hljs">@formula(y ~ x1 + x2 + x3)</code></pre><p>Moderations/interactions can be specified with the asterisk sign <code>*</code>, e.g. <code>x1 * x2</code>. This will be expanded to <code>x1 + x2 + x1:x2</code>, which, following the principle of hierarchy, the main effects must also be added along with the interaction effects. Here <code>x1:x2</code> means that the values of <code>x1</code> will be multiplied (interacted) with the values of <code>x2</code>.</p><p>Random-effects (a.k.a. group-level effects) can be specified with the <code>(term | group)</code> inside the <code>@formula</code>, where <code>term</code> is the independent variable and <code>group</code> is the <strong>categorical</strong> representation (i.e., either a column of <code>String</code>s or a <code>CategoricalArray</code> in <code>data</code>). You can specify a random-intercept with <code>(1 | group)</code>.</p><p>Example:</p><pre><code class="language-julia hljs">@formula(y ~ (1 | group) + x1)</code></pre><h3 id="Data"><a class="docs-heading-anchor" href="#Data">Data</a><a id="Data-1"></a><a class="docs-heading-anchor-permalink" href="#Data" title="Permalink"></a></h3><p>TuringGLM supports any <code>Tables.jl</code>-compatible data interface. The most popular ones are <code>DataFrame</code>s and <code>NamedTuple</code>s.</p><h3 id="Supported-Models"><a class="docs-heading-anchor" href="#Supported-Models">Supported Models</a><a id="Supported-Models-1"></a><a class="docs-heading-anchor-permalink" href="#Supported-Models" title="Permalink"></a></h3><p>TuringGLM supports non-hierarchical and hierarchical models. For hierarchical models, only single random-intercept hierarchical models are supported.</p><p>Currently, for likelihoods <code>TuringGLM.jl</code> supports:</p><ul><li><code>Normal</code> (the default if not specified): linear regression</li><li><code>TDist</code>: robust linear regression</li><li><code>Bernoulli</code>: logistic regression</li><li><code>Poisson</code>: Poisson count data regression</li><li><code>NegativeBinomial</code>: negative binomial robust count data regression</li></ul><h2 id="Tutorials"><a class="docs-heading-anchor" href="#Tutorials">Tutorials</a><a id="Tutorials-1"></a><a class="docs-heading-anchor-permalink" href="#Tutorials" title="Permalink"></a></h2><p>Take a look at the tutorials for all supported likelihood and models.</p><ul></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/linear_regression/">Linear Regression »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Saturday 30 November 2024 16:13">Saturday 30 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
 

v2.12.0/tutorials/custom_priors/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="TuringGLM.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TuringGLM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../linear_regression/">Linear Regression</a></li><li><a class="tocitem" href="../logistic_regression/">Logistic Regression</a></li><li><a class="tocitem" href="../poisson_regression/">Poisson Regression</a></li><li><a class="tocitem" href="../negative_binomial_regression/">Negative Binomial Regression</a></li><li><a class="tocitem" href="../robust_regression/">Robust Regression</a></li><li><a class="tocitem" href="../hierarchical_models/">Hierarchical Models</a></li><li class="is-active"><a class="tocitem" href>Custom Priors</a><ul class="internal"><li><a class="tocitem" href="#References"><span>References</span></a></li></ul></li></ul></li><li><a class="tocitem" href="../../api/">API reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Tutorials</a></li><li class="is-active"><a href>Custom Priors</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Custom Priors</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl/blob/main/docs/src/tutorials/custom_priors.jl" title="View source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><style>
     #documenter-page table {
         display: table !important;

v2.12.0/tutorials/hierarchical_models/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="TuringGLM.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TuringGLM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../linear_regression/">Linear Regression</a></li><li><a class="tocitem" href="../logistic_regression/">Logistic Regression</a></li><li><a class="tocitem" href="../poisson_regression/">Poisson Regression</a></li><li><a class="tocitem" href="../negative_binomial_regression/">Negative Binomial Regression</a></li><li><a class="tocitem" href="../robust_regression/">Robust Regression</a></li><li class="is-active"><a class="tocitem" href>Hierarchical Models</a><ul class="internal"><li><a class="tocitem" href="#References"><span>References</span></a></li></ul></li><li><a class="tocitem" href="../custom_priors/">Custom Priors</a></li></ul></li><li><a class="tocitem" href="../../api/">API reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Tutorials</a></li><li class="is-active"><a href>Hierarchical Models</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Hierarchical Models</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl/blob/main/docs/src/tutorials/hierarchical_models.jl" title="View source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><style>
     #documenter-page table {
         display: table !important;

v2.12.0/tutorials/linear_regression/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="TuringGLM.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TuringGLM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Tutorials</span><ul><li class="is-active"><a class="tocitem" href>Linear Regression</a><ul class="internal"><li><a class="tocitem" href="#References"><span>References</span></a></li></ul></li><li><a class="tocitem" href="../logistic_regression/">Logistic Regression</a></li><li><a class="tocitem" href="../poisson_regression/">Poisson Regression</a></li><li><a class="tocitem" href="../negative_binomial_regression/">Negative Binomial Regression</a></li><li><a class="tocitem" href="../robust_regression/">Robust Regression</a></li><li><a class="tocitem" href="../hierarchical_models/">Hierarchical Models</a></li><li><a class="tocitem" href="../custom_priors/">Custom Priors</a></li></ul></li><li><a class="tocitem" href="../../api/">API reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Tutorials</a></li><li class="is-active"><a href>Linear Regression</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Linear Regression</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl/blob/main/docs/src/tutorials/linear_regression.jl" title="View source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><style>
     #documenter-page table {
         display: table !important;

v2.12.0/tutorials/logistic_regression/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="TuringGLM.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">TuringGLM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../linear_regression/">Linear Regression</a></li><li class="is-active"><a class="tocitem" href>Logistic Regression</a><ul class="internal"><li><a class="tocitem" href="#References"><span>References</span></a></li></ul></li><li><a class="tocitem" href="../poisson_regression/">Poisson Regression</a></li><li><a class="tocitem" href="../negative_binomial_regression/">Negative Binomial Regression</a></li><li><a class="tocitem" href="../robust_regression/">Robust Regression</a></li><li><a class="tocitem" href="../hierarchical_models/">Hierarchical Models</a></li><li><a class="tocitem" href="../custom_priors/">Custom Priors</a></li></ul></li><li><a class="tocitem" href="../../api/">API reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Tutorials</a></li><li class="is-active"><a href>Logistic Regression</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Logistic Regression</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TuringLang/TuringGLM.jl/blob/main/docs/src/tutorials/logistic_regression.jl" title="View source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><style>
     #documenter-page table {
         display: table !important;