version bump

business-science · Feb 2, 2024 · 2c9789c · 2c9789c
1 parent 674d4fc
commit 2c9789c
Show file tree

Hide file tree

Showing 19 changed files with 1,266 additions and 46 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,4 @@ __pycache__/
 /_freeze/
 /.vscode/
 /.ipynb_checkpoints/
-zzz_local_tests/
+zzz_local/
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -166,6 +166,7 @@ quartodoc:
       contents:
         - augment_ewm
         - augment_cmo
+        - augment_macd
     - title: 🐼 Time Series for Pandas Series
       desc: Time series functions that generate / manipulate Pandas Series.
       package: pytimetk

diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml
@@ -44,6 +44,7 @@ website:
     - contents:
       - reference/augment_ewm.qmd
       - reference/augment_cmo.qmd
+      - reference/augment_macd.qmd
       section: "\U0001F4B9 Finance Module"
     - contents:
       - reference/make_future_timeseries.qmd

diff --git a/docs/_site/reference/augment_cmo.html b/docs/_site/reference/augment_cmo.html
@@ -390,7 +390,7 @@ <h1 class="title">augment_cmo</h1>
 
 </header>
 
-<p><code>augment_cmo(data, date_column, value_column, periods=14, reduce_memory=False, engine='pandas')</code></p>
+<p><code>augment_cmo(data, date_column, close_column, periods=14, reduce_memory=False, engine='pandas')</code></p>
 <p>The <code>augment_cmo</code> function calculates the Chande Momentum Oscillator (CMO) for a given financial instrument using either pandas or polars engine, and returns the augmented DataFrame.</p>
 <section id="parameters" class="level2">
 <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
@@ -423,9 +423,9 @@ <h2 class="anchored" data-anchor-id="parameters">Parameters</h2>
 <td><em>required</em></td>
 </tr>
 <tr class="odd">
-<td><code>value_column</code></td>
+<td><code>close_column</code></td>
 <td>Union[str, List[str]]</td>
-<td>The <code>value_column</code> parameter is used to specify the column(s) in the input data that contain the values on which the CMO will be calculated. It can be either a single column name (string) or a list of column names (if you want to calculate CMO on multiple columns).</td>
+<td>The <code>close_column</code> parameter is used to specify the column(s) in the input data that contain the values on which the CMO will be calculated. It can be either a single column name (string) or a list of column names (if you want to calculate CMO on multiple columns).</td>
 <td><em>required</em></td>
 </tr>
 <tr class="even">
@@ -497,7 +497,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
 <span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a>        .query(<span class="st">"symbol == 'AAPL'"</span>)</span>
 <span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a>        .augment_cmo(</span>
 <span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a>            date_column<span class="op">=</span><span class="st">'date'</span>,</span>
-<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a>            value_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
+<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a>            close_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
 <span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a>            periods<span class="op">=</span>[<span class="dv">14</span>, <span class="dv">28</span>]</span>
 <span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a>        )</span>
 <span id="cb1-16"><a href="#cb1-16" aria-hidden="true" tabindex="-1"></a>)</span>
@@ -680,7 +680,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
 <span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>        .groupby(<span class="st">'symbol'</span>)</span>
 <span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a>        .augment_cmo(</span>
 <span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a>            date_column<span class="op">=</span><span class="st">'date'</span>,</span>
-<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a>            value_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
+<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a>            close_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
 <span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a>            periods<span class="op">=</span>[<span class="dv">14</span>, <span class="dv">28</span>]</span>
 <span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a>        )</span>
 <span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a>)</span>
@@ -797,7 +797,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
 <span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a>        .query(<span class="st">"symbol == 'AAPL'"</span>)</span>
 <span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a>        .augment_cmo(</span>
 <span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a>            date_column<span class="op">=</span><span class="st">'date'</span>,</span>
-<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a>            value_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
+<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a>            close_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
 <span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a>            periods<span class="op">=</span>[<span class="dv">14</span>, <span class="dv">28</span>],</span>
 <span id="cb3-9"><a href="#cb3-9" aria-hidden="true" tabindex="-1"></a>            engine<span class="op">=</span><span class="st">'polars'</span></span>
 <span id="cb3-10"><a href="#cb3-10" aria-hidden="true" tabindex="-1"></a>        )</span>
@@ -981,7 +981,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
 <span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a>        .groupby(<span class="st">'symbol'</span>)</span>
 <span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a>        .augment_cmo(</span>
 <span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a>            date_column<span class="op">=</span><span class="st">'date'</span>,</span>
-<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a>            value_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
+<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a>            close_column<span class="op">=</span><span class="st">'adjusted'</span>,</span>
 <span id="cb4-8"><a href="#cb4-8" aria-hidden="true" tabindex="-1"></a>            periods<span class="op">=</span>[<span class="dv">14</span>, <span class="dv">28</span>],</span>
 <span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a>            engine<span class="op">=</span><span class="st">'polars'</span></span>
 <span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a>        )</span>