Skip to content

Commit

Permalink
build based on 80342bf
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 19, 2024
1 parent fa8242a commit 58db144
Show file tree
Hide file tree
Showing 14 changed files with 988 additions and 15,992 deletions.
1 change: 1 addition & 0 deletions dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-19T01:30:00","documenter_version":"1.4.0"}}
4 changes: 2 additions & 2 deletions dev/advanced_usage/index.html
View file
Original file line number Diff line number Diff line change
@@ -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>Advanced Usage · TexTables.jl</title><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.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/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="../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="../">TexTables.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Introduction</a></li><li><a class="tocitem" href="../easy_examples/">Easy Examples</a></li><li><a class="tocitem" href="../basic_usage/">Basic Usage</a></li><li><a class="tocitem" href="../regression_tables/">Regression API</a></li><li class="is-active"><a class="tocitem" href>Advanced Usage</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Building-Tables-from-Scratch"><span>Building Tables from Scratch</span></a></li><li><a class="tocitem" href="#Constructing-Columns-From-Vectors:"><span>Constructing Columns From Vectors:</span></a></li><li><a class="tocitem" href="#Constructing-Columns-with-Standard-Errors"><span>Constructing Columns with Standard Errors</span></a></li><li><a class="tocitem" href="#Constructing-Columns-from-:-Associative"><span>Constructing Columns from <code>&lt;: Associative</code></span></a></li><li><a class="tocitem" href="#A-word-of-caution-about-merging-tables"><span>A word of caution about merging tables</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Advanced Usage</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Advanced Usage</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/jacobadenbaum/TexTables.jl/blob/master/docs/src/advanced_usage.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Advanced-Usage"><a class="docs-heading-anchor" href="#Advanced-Usage">Advanced Usage</a><a id="Advanced-Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Advanced-Usage" title="Permalink"></a></h1><p>These sections are for advanced users who are interested in fine-tuning their own custom tables or integrating <code>TexTables</code> into their packages.</p><h1 id="Building-Tables-from-Scratch"><a class="docs-heading-anchor" href="#Building-Tables-from-Scratch">Building Tables from Scratch</a><a id="Building-Tables-from-Scratch-1"></a><a class="docs-heading-anchor-permalink" href="#Building-Tables-from-Scratch" title="Permalink"></a></h1><p>The core object when constructing tables with <code>TexTables</code> is the <code>TableCol</code> type. This is just a wrapper around an <code>OrderedDict</code> and a header index, that enforces conversion of the header and the keys to a special multi-index type that work with the <code>TexTables</code> structure for printing.</p><p>Let&#39;s make up some data (values, keys, and standard errors) so that we can see all of the different ways to construct columns:</p><pre><code class="language-julia hljs">julia&gt; Random.seed!(1234);
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Advanced Usage · TexTables.jl</title><meta name="title" content="Advanced Usage · TexTables.jl"/><meta property="og:title" content="Advanced Usage · TexTables.jl"/><meta property="twitter:title" content="Advanced Usage · TexTables.jl"/><meta name="description" content="Documentation for TexTables.jl."/><meta property="og:description" content="Documentation for TexTables.jl."/><meta property="twitter:description" content="Documentation for TexTables.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="../">TexTables.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="../easy_examples/">Easy Examples</a></li><li><a class="tocitem" href="../basic_usage/">Basic Usage</a></li><li><a class="tocitem" href="../regression_tables/">Regression API</a></li><li class="is-active"><a class="tocitem" href>Advanced Usage</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Building-Tables-from-Scratch"><span>Building Tables from Scratch</span></a></li><li><a class="tocitem" href="#Constructing-Columns-From-Vectors:"><span>Constructing Columns From Vectors:</span></a></li><li><a class="tocitem" href="#Constructing-Columns-with-Standard-Errors"><span>Constructing Columns with Standard Errors</span></a></li><li><a class="tocitem" href="#Constructing-Columns-from-:-Associative"><span>Constructing Columns from <code>&lt;: Associative</code></span></a></li><li><a class="tocitem" href="#A-word-of-caution-about-merging-tables"><span>A word of caution about merging tables</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>Advanced Usage</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Advanced Usage</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/jacobadenbaum/TexTables.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/jacobadenbaum/TexTables.jl/blob/master/docs/src/advanced_usage.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="Advanced-Usage"><a class="docs-heading-anchor" href="#Advanced-Usage">Advanced Usage</a><a id="Advanced-Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Advanced-Usage" title="Permalink"></a></h1><p>These sections are for advanced users who are interested in fine-tuning their own custom tables or integrating <code>TexTables</code> into their packages.</p><h1 id="Building-Tables-from-Scratch"><a class="docs-heading-anchor" href="#Building-Tables-from-Scratch">Building Tables from Scratch</a><a id="Building-Tables-from-Scratch-1"></a><a class="docs-heading-anchor-permalink" href="#Building-Tables-from-Scratch" title="Permalink"></a></h1><p>The core object when constructing tables with <code>TexTables</code> is the <code>TableCol</code> type. This is just a wrapper around an <code>OrderedDict</code> and a header index, that enforces conversion of the header and the keys to a special multi-index type that work with the <code>TexTables</code> structure for printing.</p><p>Let&#39;s make up some data (values, keys, and standard errors) so that we can see all of the different ways to construct columns:</p><pre><code class="language-julia hljs">julia&gt; Random.seed!(1234);

julia&gt; vals = randn(10)
10-element Array{Float64,1}:
Expand Down Expand Up @@ -120,4 +120,4 @@
Mean | | 66.600
Std | | 13.315
Min | | 37
Max | | 90</code></pre><p>This result, while perhaps unintuitive, is by design. <code>cols[1]</code> and <code>cols[2]</code> really are not of a shape that could be put together vertically (at least not without overwriting one of their column names). But rather than give an error when some keys are not present, <code>TexTables</code> tries it&#39;s best to put them together in the order you&#39;ve requested. This behavior is essential for horizontally concatenating two regression tables with summary statistics blocks at the bottom. In general, whenever you concatenate two tables, they need to have the same structure in the dimension that they are not being joined upon, or the results will probably not be what you expected.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../regression_tables/">« Regression API</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="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 0.27.10 on <span class="colophon-date" title="Friday 5 November 2021 15:16">Friday 5 November 2021</span>. Using Julia version 1.6.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Max | | 90</code></pre><p>This result, while perhaps unintuitive, is by design. <code>cols[1]</code> and <code>cols[2]</code> really are not of a shape that could be put together vertically (at least not without overwriting one of their column names). But rather than give an error when some keys are not present, <code>TexTables</code> tries it&#39;s best to put them together in the order you&#39;ve requested. This behavior is essential for horizontally concatenating two regression tables with summary statistics blocks at the bottom. In general, whenever you concatenate two tables, they need to have the same structure in the dimension that they are not being joined upon, or the results will probably not be what you expected.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../regression_tables/">« Regression API</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.0 on <span class="colophon-date" title="Friday 19 April 2024 01:30">Friday 19 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 58db144

Please sign in to comment.