update rendered docs site

scicloj · Aug 9, 2024 · 4657cb3 · 4657cb3
1 parent 7b24479
commit 4657cb3
Showing 1 changed file with 15 additions and 15 deletions.
diff --git a/docs/scicloj.tcutils.api.html b/docs/scicloj.tcutils.api.html
@@ -2,8 +2,8 @@
     "">
 <html><head><meta charset="UTF-8" /><title>scicloj.tcutils.api documentation</title><script defer="true" src="https://cloud.umami.is/script.js" data-website-id="7f05c81b-38ea-4916-aa00-9d1631cf0681"></script><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/solarized-light.css" /><script type="text/javascript" src="highlight/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a> with <a href="https://github.com/xsc/codox-theme-rdash">RDash UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">tcutils</span> <span class="project-version">0.1.0-alpha2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to tcutils</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scicloj</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tcutils</span></div></div></li><li class="depth-3 branch current"><a href="scicloj.tcutils.api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>api</span></div></a></li><li class="depth-3"><a href="scicloj.tcutils.strings.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>strings</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="scicloj.tcutils.api.html#var-between"><div class="inner"><span>between</span></div></a></li><li class="depth-1"><a href="scicloj.tcutils.api.html#var-clean-column-names"><div class="inner"><span>clean-column-names</span></div></a></li><li class="depth-1"><a href="scicloj.tcutils.api.html#var-cumsum"><div class="inner"><span>cumsum</span></div></a></li><li class="depth-1"><a href="scicloj.tcutils.api.html#var-duplicate-rows"><div class="inner"><span>duplicate-rows</span></div></a></li><li class="depth-1"><a href="scicloj.tcutils.api.html#var-lag"><div class="inner"><span>lag</span></div></a></li><li class="depth-1"><a href="scicloj.tcutils.api.html#var-lead"><div class="inner"><span>lead</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">scicloj.tcutils.api</h1><div class="doc"><div class="markdown"></div></div><div class="public anchor" id="var-between"><h3>between</h3><div class="usage"><code>(between ds col-name low high)</code><code>(between ds col-selector low high {:keys [missing-default]})</code></div><div class="doc"><div class="markdown"><p>Detect where values fall in a specified range in a numeric column. This is a shortcut for <code>(&lt; low x high)</code>.</p>
 <h2>Usage</h2>
-<p><code>(between ds col-name low high)</code>
-<code>(between ds col-name low high {:missing-default val})</code></p>
+<p><code>(between ds col-name low high)</code></p>
+<p><code>(between ds col-name low high {:missing-default val})</code></p>
 <h2>Arguments</h2>
 <ul>
 <li><code>ds</code> - A <code>tech.ml.dataset</code> (i.e a <code>tablecloth</code> dataset)</li>
@@ -14,7 +14,7 @@ <h2>Arguments</h2>
 </ul>
 <h2>Returns</h2>
 <p>A dataset with only rows that contain values between <code>low</code> and <code>high</code> in column <code>col-name</code></p>
-</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L122">view source</a></div></div><div class="public anchor" id="var-clean-column-names"><h3>clean-column-names</h3><div class="usage"><code>(clean-column-names ds)</code></div><div class="doc"><div class="markdown"><p>Convert column names of a dataset into ASCII-only, kebab-cased keywords. Throws an error if any column would be left with no name, e.g. one that was an all non-ASCII string.</p>
+</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L125">view source</a></div></div><div class="public anchor" id="var-clean-column-names"><h3>clean-column-names</h3><div class="usage"><code>(clean-column-names ds)</code></div><div class="doc"><div class="markdown"><p>Convert column names of a dataset into ASCII-only, kebab-cased keywords. Throws an error if any column would be left with no name, e.g. one that was an all non-ASCII string.</p>
 <h2>Usage</h2>
 <p><code>clean-column-names(ds)</code></p>
 <h2>Arguments</h2>
@@ -23,10 +23,10 @@ <h2>Arguments</h2>
 </ul>
 <h2>Returns</h2>
 <p>A dataset with the column names converted to ASCII-only, kebab-cased keywords.</p>
-</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L105">view source</a></div></div><div class="public anchor" id="var-cumsum"><h3>cumsum</h3><div class="usage"><code>(cumsum ds column-name)</code><code>(cumsum ds new-column-name column-name)</code></div><div class="doc"><div class="markdown"><p>Compute the cumulative sum of a column</p>
+</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L108">view source</a></div></div><div class="public anchor" id="var-cumsum"><h3>cumsum</h3><div class="usage"><code>(cumsum ds column-name)</code><code>(cumsum ds new-column-name column-name)</code></div><div class="doc"><div class="markdown"><p>Compute the cumulative sum of a column</p>
 <h2>Usage</h2>
-<p><code>(cumsum ds column-name)</code>
-<code>(cumsum ds new-column-name column-name)</code></p>
+<p><code>(cumsum ds column-name)</code></p>
+<p><code>(cumsum ds new-column-name column-name)</code></p>
 <h2>Arguments</h2>
 <ul>
 <li><code>ds</code> - A <code>tech.ml.dataset</code> (i.e a <code>tablecloth</code> dataset)</li>
@@ -36,7 +36,7 @@ <h2>Arguments</h2>
 </ul>
 <h2>Returns</h2>
 <p>A dataset with the additional column containing the cumulative sum.</p>
-</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L78">view source</a></div></div><div class="public anchor" id="var-duplicate-rows"><h3>duplicate-rows</h3><div class="usage"><code>(duplicate-rows ds)</code></div><div class="doc"><div class="markdown"><p>Filter a dataset for only duplicated rows.</p>
+</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L80">view source</a></div></div><div class="public anchor" id="var-duplicate-rows"><h3>duplicate-rows</h3><div class="usage"><code>(duplicate-rows ds)</code></div><div class="doc"><div class="markdown"><p>Filter a dataset for only duplicated rows.</p>
 <h2>Usage</h2>
 <p><code>(duplicate-rows ds)</code></p>
 <h2>Arguments</h2>
@@ -45,10 +45,10 @@ <h2>Arguments</h2>
 </ul>
 <h2>Returns</h2>
 <p>A dataset containing only rows that are exact duplicates.</p>
-</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L146">view source</a></div></div><div class="public anchor" id="var-lag"><h3>lag</h3><div class="usage"><code>(lag ds column-name lag-size)</code><code>(lag ds new-column-name column-name lag-size)</code></div><div class="doc"><div class="markdown"><p>Compute previous (lagged) values from one column in a new column, can be used e.g. to compare values behind the current value.</p>
+</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L150">view source</a></div></div><div class="public anchor" id="var-lag"><h3>lag</h3><div class="usage"><code>(lag ds column-name lag-size)</code><code>(lag ds new-column-name column-name lag-size)</code></div><div class="doc"><div class="markdown"><p>Compute previous (lagged) values from one column in a new column, can be used e.g. to compare values behind the current value.</p>
 <h2>Usage</h2>
-<p><code>(lag ds column-name lag-size)</code>
-<code>(lag ds new-column-name column-name lag-size)</code></p>
+<p><code>(lag ds column-name lag-size)</code></p>
+<p><code>(lag ds new-column-name column-name lag-size)</code></p>
 <h2>Arguments</h2>
 <ul>
 <li><code>ds</code> - A <code>tech.ml.dataset</code> (i.e a <code>tablecloth</code> dataset)</li>
@@ -61,16 +61,16 @@ <h2>Returns</h2>
 <p>A dataset with the new column populated with the lagged values.</p>
 </div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L10">view source</a></div></div><div class="public anchor" id="var-lead"><h3>lead</h3><div class="usage"><code>(lead ds column-name lead-size)</code><code>(lead ds new-column-name column-name lead-size)</code></div><div class="doc"><div class="markdown"><p>Compute next (lead) values from one column in a new column, can be used e.g. to compare values ahead of the current value.</p>
 <h2>Usage</h2>
-<p><code>(lead ds column-name lead-size)</code>
-<code>(lead ds new-column-name column-name lead-size)</code></p>
+<p><code>(lead ds column-name lead-size)</code></p>
+<p><code>(lead ds new-column-name column-name lead-size)</code></p>
 <h2>Arguments</h2>
 <ul>
 <li><code>ds</code> - A <code>tech.ml.dataset</code> (i.e a <code>tablecloth</code> dataset)</li>
 <li><code>new-column-name</code> - <strong>optional</strong> Name for the column where newly computed values will go.
-When ommitted new column name defaults to the keyword <code>&lt;old-column-name&gt;-lead-&lt;lag-size&gt;</code></li>
+When ommitted new column name defaults to the keyword <code>&lt;old-column-name&gt;-lead-&lt;lead-size&gt;</code></li>
 <li><code>column-name</code> - Name of the column to use to compute the lead values</li>
 <li><code>lead-size</code> - positive integer indicating how many rows to skip over to compute the lead</li>
 </ul>
 <h2>Returns</h2>
-<p>A dataset with the column populated with the lagged values.</p>
-</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L44">view source</a></div></div></div></body></html>
+<p>A dataset with the column populated with the lead values.</p>
+</div></div><div class="src-link"><a href="https://github.com/scicloj/tcutils/blob/master/src/scicloj/tcutils/api.clj#L45">view source</a></div></div></div></body></html>