build based on 3355411

markgpritchard · Dec 15, 2023 · a190d1c · a190d1c
1 parent d11a806
commit a190d1c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-12-15T13:26:43","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-12-15T14:10:12","documenter_version":"1.2.1"}}
diff --git a/dev/index.html b/dev/index.html
@@ -1,2 +1,18 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>- · TableOne Documentation</title><meta name="title" content="- · TableOne Documentation"/><meta property="og:title" content="- · TableOne Documentation"/><meta property="twitter:title" content="- · TableOne Documentation"/><meta name="description" content="Documentation for TableOne Documentation."/><meta property="og:description" content="Documentation for TableOne Documentation."/><meta property="twitter:description" content="Documentation for TableOne Documentation."/><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>TableOne Documentation</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>-</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>-</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>-</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/markgpritchard/TableOne.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/markgpritchard/TableOne.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"></article><nav class="docs-footer"><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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 15 December 2023 13:26">Friday 15 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>TableOne.jl Documentation · TableOne Documentation</title><meta name="title" content="TableOne.jl Documentation · TableOne Documentation"/><meta property="og:title" content="TableOne.jl Documentation · TableOne Documentation"/><meta property="twitter:title" content="TableOne.jl Documentation · TableOne Documentation"/><meta name="description" content="Documentation for TableOne Documentation."/><meta property="og:description" content="Documentation for TableOne Documentation."/><meta property="twitter:description" content="Documentation for TableOne Documentation."/><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>TableOne Documentation</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>TableOne.jl Documentation</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>TableOne.jl Documentation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>TableOne.jl Documentation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/markgpritchard/TableOne.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/markgpritchard/TableOne.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="TableOne.jl-Documentation"><a class="docs-heading-anchor" href="#TableOne.jl-Documentation">TableOne.jl Documentation</a><a id="TableOne.jl-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#TableOne.jl-Documentation" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="TableOne.tableone" href="#TableOne.tableone"><code>TableOne.tableone</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tableone(data, strata[, vars]; &lt;keyword arguments&gt;)</code></pre><p>Produce a summary table which may be used as Table 1 in a manuscript.</p><p><strong>Arguments</strong></p><ul><li><code>data</code>: A <code>DataFrame</code> containing the data to be included in the table</li><li><code>strata</code>: The variable (a column in <code>data</code>) by which the data should be stratified    in the table</li><li><code>vars</code>: The variables to be listed in the table, defaults to <code>Symbol.(names(data))</code>    if not supplied</li></ul><p><strong>Keyword arguments</strong></p><p><strong>Types of variables</strong></p><p>Each of these must be supplied as the same type as <code>vars</code>, e.g. if <code>vars</code> is a <code>Vector{Symbol}</code>      then these should each be a <code>Vector{Symbol}</code>. Variables supplied to one of these      arguments but not the main <code>vars</code> argument will not be displayed.</p><ul><li><code>binvars</code>: binary variables – variable will take one row and show <code>number (%)</code>    with the selected level (see <code>binvardisplay</code> below)</li><li><code>catvars</code>: categorical variables – each level in the variable will be shown on    a separate line with the <code>number (%)</code> in that category</li><li><code>npvars</code>: non-parametric variables – will display <code>median [1st–3rd quartiles]</code></li></ul><p>Any variables not included in one of these arguments will be presented as      <code>mean (standard deviation)</code> if the contents of the variable are      <code>&lt;:Union{&lt;:Number, Missing}</code>, and as categorical otherwise.</p><p><strong>Additional keyword arguments</strong></p><ul><li><code>addnmissing = true</code>: include the numer of records with missing values for each    variable. If <code>true</code>, will also display number with missing <code>strata</code> values</li><li><code>addtotal = false</code>: include a column of totals across all <code>strata</code></li><li><code>binvardisplay = nothing</code>: optionally, a <code>Dict</code> to choose the level to display    for binary values. Any variables not listed will use the value chosen by <code>maximum(skipmissing(.))</code></li><li><code>varnames = nothing</code>: optionally, a <code>Dict</code> of names for variables different    from the column titles in <code>data</code>, of the form <code>Dict(:columnname =&gt; &quot;name to print&quot;)</code>.    Any variables not included will be listed by the column name</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using TableOne, CSV, DataFrames, Downloads
+# use the public PBC dataset
+julia&gt; pbcdata = CSV.read(
+    Downloads.download(&quot;http://www-eio.upc.edu/~pau/cms/rdata/csv/survival/pbc.csv&quot;),
+    DataFrame;
+    missingstring = &quot;NA&quot;)
+julia&gt; tableone(
+    pbcdata,
+    :trt,
+    [ &quot;time&quot;, &quot;status&quot;, &quot;age&quot;, &quot;sex&quot;, &quot;ascites&quot;, &quot;hepato&quot;, &quot;spiders&quot;, &quot;edema&quot;,
+        &quot;bili&quot;, &quot;chol&quot;, &quot;albumin&quot;, &quot;copper&quot;, &quot;alk.phos&quot;, &quot;ast&quot;, &quot;trig&quot;, &quot;platelet&quot;,
+        &quot;protime&quot;, &quot;stage&quot; ];
+    binvars = [ &quot;sex&quot;, &quot;ascites&quot;, &quot;hepato&quot;, &quot;spiders&quot; ],
+    catvars = [ &quot;status&quot;, &quot;edema&quot;, &quot;stage&quot; ],
+    nparms = [ &quot;bili&quot;, &quot;chol&quot;, &quot;copper&quot;, &quot;alk.phos&quot;, &quot;trig&quot; ],
+    digits = 2,
+    binvardisplay = Dict(&quot;sex&quot; =&gt; &quot;f&quot;))</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/markgpritchard/TableOne.jl/blob/335541124a3bf0ba79eaaee7de17c12ee5ac4331/src/TableOne.jl#L8-L66">source</a></section></article></article><nav class="docs-footer"><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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 15 December 2023 14:10">Friday 15 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/search_index.js b/dev/search_index.js