Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified doc/_build/html/.doctrees/api.doctree
Binary file not shown.
Binary file modified doc/_build/html/.doctrees/environment.pickle
Binary file not shown.
8 changes: 6 additions & 2 deletions doc/_build/html/_modules/moderndive/infer/core.html
Original file line number Diff line number Diff line change
Expand Up @@ -684,10 +684,14 @@ <h1>Source code for moderndive.infer.core</h1><div class="highlight"><pre>

<span class="k">return</span> <span class="n">get_fit_p_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs_stat</span><span class="o">=</span><span class="n">obs_stat</span><span class="p">,</span> <span class="n">direction</span><span class="o">=</span><span class="n">direction</span><span class="p">)</span>

<span class="k">def</span><span class="w"> </span><span class="nf">visualize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bins</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">engine</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;plotly&quot;</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">visualize</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">bins</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">engine</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;plotly&quot;</span><span class="p">,</span> <span class="n">shade_pvalue</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">shade_ci</span><span class="o">=</span><span class="kc">None</span>
<span class="p">):</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.viz</span><span class="w"> </span><span class="kn">import</span> <span class="n">visualize_fit</span>

<span class="k">return</span> <span class="n">visualize_fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bins</span><span class="o">=</span><span class="n">bins</span><span class="p">,</span> <span class="n">engine</span><span class="o">=</span><span class="n">engine</span><span class="p">)</span></div>
<span class="k">return</span> <span class="n">visualize_fit</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">bins</span><span class="o">=</span><span class="n">bins</span><span class="p">,</span> <span class="n">engine</span><span class="o">=</span><span class="n">engine</span><span class="p">,</span> <span class="n">shade_pvalue</span><span class="o">=</span><span class="n">shade_pvalue</span><span class="p">,</span> <span class="n">shade_ci</span><span class="o">=</span><span class="n">shade_ci</span>
<span class="p">)</span></div>



Expand Down
135 changes: 120 additions & 15 deletions doc/_build/html/_modules/moderndive/infer/viz.html

Large diffs are not rendered by default.

Binary file modified doc/_build/html/_static/moderndive-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions doc/_build/html/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,9 @@ <h2>Getters and visualization<a class="headerlink" href="#getters-and-visualizat
<dt class="sig sig-object py" id="moderndive.shade_p_value">
<span class="sig-prename descclassname"><span class="pre">moderndive.</span></span><span class="sig-name descname"><span class="pre">shade_p_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obs_stat</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">direction</span></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/moderndive/infer/viz.html#shade_p_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#moderndive.shade_p_value" title="Link to this definition">¶</a></dt>
<dd><p>A p-value shading spec; add it to a <code class="docutils literal notranslate"><span class="pre">visualize()</span></code> plot with <code class="docutils literal notranslate"><span class="pre">+</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">direction</span></code> ∈ {right/greater, left/less, two-sided}.</p>
<p><code class="docutils literal notranslate"><span class="pre">direction</span></code> ∈ {right/greater, left/less, two-sided}. For a faceted
<code class="xref py py-func docutils literal notranslate"><span class="pre">visualize_fit()</span></code> plot, pass a per-term <code class="docutils literal notranslate"><span class="pre">obs_stat</span></code> — an observed
<code class="docutils literal notranslate"><span class="pre">FitResult</span></code>, a <code class="docutils literal notranslate"><span class="pre">term</span></code>-keyed frame, or a dict — to shade each facet.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">ShadeSpec</span></code></span></p>
Expand All @@ -605,7 +607,9 @@ <h2>Getters and visualization<a class="headerlink" href="#getters-and-visualizat
<dt class="sig sig-object py" id="moderndive.shade_confidence_interval">
<span class="sig-prename descclassname"><span class="pre">moderndive.</span></span><span class="sig-name descname"><span class="pre">shade_confidence_interval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoints</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/moderndive/infer/viz.html#shade_confidence_interval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#moderndive.shade_confidence_interval" title="Link to this definition">¶</a></dt>
<dd><p>A confidence-interval shading spec; add it to a <code class="docutils literal notranslate"><span class="pre">visualize()</span></code> plot with <code class="docutils literal notranslate"><span class="pre">+</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">endpoints</span></code> is a CI DataFrame (<code class="docutils literal notranslate"><span class="pre">lower_ci</span></code>/<code class="docutils literal notranslate"><span class="pre">upper_ci</span></code>) or a <code class="docutils literal notranslate"><span class="pre">(lower,</span> <span class="pre">upper)</span></code> tuple.</p>
<p><code class="docutils literal notranslate"><span class="pre">endpoints</span></code> is a CI DataFrame (<code class="docutils literal notranslate"><span class="pre">lower_ci</span></code>/<code class="docutils literal notranslate"><span class="pre">upper_ci</span></code>) or a <code class="docutils literal notranslate"><span class="pre">(lower,</span> <span class="pre">upper)</span></code>
tuple. For a faceted <code class="xref py py-func docutils literal notranslate"><span class="pre">visualize_fit()</span></code> plot, pass a per-term CI table (with a
<code class="docutils literal notranslate"><span class="pre">term</span></code> column) to shade each facet from its own interval.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">ShadeSpec</span></code></span></p>
Expand Down
2 changes: 1 addition & 1 deletion doc/_build/html/searchindex.js

Large diffs are not rendered by default.

Binary file modified doc/_static/moderndive-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "moderndive"
version = "0.1.0"
description = "Python companion for ModernDive: a tidy simulation-inference grammar, regression helpers, and datasets"
description = "Python companion for ModernDive: a tidy simulation-inference grammar, regression helpers, datasets, and dual-engine plotly/plotnine plots"
readme = "README.md"
requires-python = ">=3.11"
license = { text = "MIT" }
Expand Down
Loading