build based on 60d6945

jmboehm · Sep 9, 2024 · 5c86f29 · 5c86f29
1 parent 804599a
commit 5c86f29
Show file tree

Hide file tree

Showing 17 changed files with 101 additions and 83 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-16T20:52:45","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-09T20:51:42","documenter_version":"1.7.0"}}
diff --git a/dev/api/index.html b/dev/api/index.html
diff --git a/dev/assets/documenter.js b/dev/assets/documenter.js
diff --git a/dev/assets/themes/catppuccin-frappe.css b/dev/assets/themes/catppuccin-frappe.css
diff --git a/dev/assets/themes/catppuccin-latte.css b/dev/assets/themes/catppuccin-latte.css
diff --git a/dev/assets/themes/catppuccin-macchiato.css b/dev/assets/themes/catppuccin-macchiato.css
diff --git a/dev/assets/themes/catppuccin-mocha.css b/dev/assets/themes/catppuccin-mocha.css
diff --git a/dev/assets/themes/documenter-dark.css b/dev/assets/themes/documenter-dark.css
diff --git a/dev/assets/themes/documenter-light.css b/dev/assets/themes/documenter-light.css
diff --git a/dev/custom_model/index.html b/dev/custom_model/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Custom Model Example · RegressionTables.jl</title><meta name="title" content="Custom Model Example · RegressionTables.jl"/><meta property="og:title" content="Custom Model Example · RegressionTables.jl"/><meta property="twitter:title" content="Custom Model Example · RegressionTables.jl"/><meta name="description" content="Documentation for RegressionTables.jl."/><meta property="og:description" content="Documentation for RegressionTables.jl."/><meta property="twitter:description" content="Documentation for RegressionTables.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">RegressionTables.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="../">Introduction</a></li><li><a class="tocitem" href="../regression_statistics/">Regression Statistics</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../keep_drop_order/">Keep Drop and Order Arguments</a></li><li><a class="tocitem" href="../api/">API</a></li><li><a class="tocitem" href="../customization/">Customization and Defaults</a></li><li><a class="tocitem" href="../function_reference/">Function and Type Reference</a></li><li class="is-active"><a class="tocitem" href>Custom Model Example</a><ul class="internal"><li><a class="tocitem" href="#The-Model"><span>The Model</span></a></li><li><a class="tocitem" href="#Adding-a-Custom-Statistic"><span>Adding a Custom Statistic</span></a></li></ul></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>Custom Model Example</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Custom Model Example</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/jmboehm/RegressionTables.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/jmboehm/RegressionTables.jl/blob/master/docs/src/custom_model.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="Using-RegressionTables-with-a-Custom-Model"><a class="docs-heading-anchor" href="#Using-RegressionTables-with-a-Custom-Model">Using RegressionTables with a Custom Model</a><a id="Using-RegressionTables-with-a-Custom-Model-1"></a><a class="docs-heading-anchor-permalink" href="#Using-RegressionTables-with-a-Custom-Model" title="Permalink"></a></h1><p>RegressionTables.jl is designed to be used with any custom model you create. The easiest way for this to work is to copy the <a href="https://github.com/JuliaStats/StatsAPI.jl">StatsAPI.jl</a> API, if that API is fully implemented then RegressionTables.jl will work out of the box. This page will provide a simple example of this.</p><h2 id="The-Model"><a class="docs-heading-anchor" href="#The-Model">The Model</a><a id="The-Model-1"></a><a class="docs-heading-anchor-permalink" href="#The-Model" title="Permalink"></a></h2><p>This will setup a simple linear model:</p><pre><code class="language-julia hljs">using StatsAPI, RDatasets, RegressionTables, Statistics
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Custom Model Example · RegressionTables.jl</title><meta name="title" content="Custom Model Example · RegressionTables.jl"/><meta property="og:title" content="Custom Model Example · RegressionTables.jl"/><meta property="twitter:title" content="Custom Model Example · RegressionTables.jl"/><meta name="description" content="Documentation for RegressionTables.jl."/><meta property="og:description" content="Documentation for RegressionTables.jl."/><meta property="twitter:description" content="Documentation for RegressionTables.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">RegressionTables.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="../">Introduction</a></li><li><a class="tocitem" href="../regression_statistics/">Regression Statistics</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../keep_drop_order/">Keep Drop and Order Arguments</a></li><li><a class="tocitem" href="../api/">API</a></li><li><a class="tocitem" href="../customization/">Customization and Defaults</a></li><li><a class="tocitem" href="../function_reference/">Function and Type Reference</a></li><li class="is-active"><a class="tocitem" href>Custom Model Example</a><ul class="internal"><li><a class="tocitem" href="#The-Model"><span>The Model</span></a></li><li><a class="tocitem" href="#Adding-a-Custom-Statistic"><span>Adding a Custom Statistic</span></a></li></ul></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>Custom Model Example</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Custom Model Example</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/jmboehm/RegressionTables.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/jmboehm/RegressionTables.jl/blob/master/docs/src/custom_model.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="Using-RegressionTables-with-a-Custom-Model"><a class="docs-heading-anchor" href="#Using-RegressionTables-with-a-Custom-Model">Using RegressionTables with a Custom Model</a><a id="Using-RegressionTables-with-a-Custom-Model-1"></a><a class="docs-heading-anchor-permalink" href="#Using-RegressionTables-with-a-Custom-Model" title="Permalink"></a></h1><p>RegressionTables.jl is designed to be used with any custom model you create. The easiest way for this to work is to copy the <a href="https://github.com/JuliaStats/StatsAPI.jl">StatsAPI.jl</a> API, if that API is fully implemented then RegressionTables.jl will work out of the box. This page will provide a simple example of this.</p><h2 id="The-Model"><a class="docs-heading-anchor" href="#The-Model">The Model</a><a id="The-Model-1"></a><a class="docs-heading-anchor-permalink" href="#The-Model" title="Permalink"></a></h2><p>This will setup a simple linear model:</p><pre><code class="language-julia hljs">using StatsAPI, RDatasets, RegressionTables, Statistics
 df = RDatasets.dataset(&quot;plm&quot;, &quot;Cigar&quot;)
 df[!, :intercept] = ones(nrow(df))
 
@@ -104,4 +104,4 @@
 My Statistic      137.549      139.505      132.980
 ---------------------------------------------------
 
-</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../function_reference/">« Function and Type Reference</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 16 June 2024 20:52">Sunday 16 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../function_reference/">« Function and Type Reference</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.7.0 on <span class="colophon-date" title="Monday 9 September 2024 20:51">Monday 9 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-16T20:52:45","documenter_version":"1.4.1"}}
		{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-09T20:51:42","documenter_version":"1.7.0"}}