Add .nojekyll file

amanda-park · Mar 10, 2021 · 364d508 · 364d508
1 parent 31ed5ab
commit 364d508
Show file tree

Hide file tree

Showing 33 changed files with 96 additions and 39 deletions.
diff --git a/__pycache__/interactive_visuals.cpython-38.pyc b/__pycache__/interactive_visuals.cpython-38.pyc
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/source/interactive_visuals.doctree b/docs/_build/doctrees/source/interactive_visuals.doctree
diff --git a/docs/_build/doctrees/source/vignette.doctree b/docs/_build/doctrees/source/vignette.doctree
diff --git a/docs/_build/html/_images/Barplot_Basic.png b/docs/_build/html/_images/Barplot_Basic.png
diff --git a/docs/_build/html/_images/Control_Chart.png b/docs/_build/html/_images/Control_Chart.png
diff --git a/docs/_build/html/_images/Histogram_Basic.png b/docs/_build/html/_images/Histogram_Basic.png
diff --git a/docs/_build/html/_images/Scatterplot_Basic.png b/docs/_build/html/_images/Scatterplot_Basic.png
diff --git a/docs/_build/html/_images/Scatterplot_Marginal.png b/docs/_build/html/_images/Scatterplot_Marginal.png
diff --git a/docs/_build/html/_images/Scatterplot_Marginal_Factor.png b/docs/_build/html/_images/Scatterplot_Marginal_Factor.png
diff --git a/docs/_build/html/_images/Scatterplot_Marginal_Jitter.png b/docs/_build/html/_images/Scatterplot_Marginal_Jitter.png
diff --git a/docs/_build/html/_images/Scatterplot_Marginal_Numeric.png b/docs/_build/html/_images/Scatterplot_Marginal_Numeric.png
diff --git a/docs/_build/html/_images/Scatterplot_Marginal_Opacity.png b/docs/_build/html/_images/Scatterplot_Marginal_Opacity.png
diff --git a/docs/_build/html/_images/Scatterplot_Marginal_Trendline.png b/docs/_build/html/_images/Scatterplot_Marginal_Trendline.png
diff --git a/docs/_build/html/_sources/source/vignette.rst.txt b/docs/_build/html/_sources/source/vignette.rst.txt
@@ -32,6 +32,8 @@ For creating control charts, the data frame must contain variables named the sam
   iv = Interactive_Visuals(df)
   plot(iv.control_chart_ADTK(title = "Anomaly Detection Graph"))
 
+.. image:: images/Control_Chart.png
+   :width: 800
 
 ===========
 Scatterplot
@@ -49,45 +51,66 @@ To obtain a very basic scatterplot, run this:
 .. code-block:: Python
 
   plot(iv.scatterplot(x = "sepal_length", y = "sepal_width"))
-  
+
+.. image:: images/Scatterplot_Basic.png
+   :width: 800
+
 To create a scatterplot with a marginal box plot, run the following:
 
 .. code-block:: Python
 
   plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box"))
-    
+
+.. image:: images/Scatterplot_Marginal.png
+   :width: 800
+
 (Note that histograms or violin plots can also be plotted in the margins.)
 
 Scatterplots can be labeled based on a factor variable:
 
 .. code-block:: Python
 
   plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box", color = "species"))
+
+.. image:: images/Scatterplot_Marginal_Factor.png
+   :width: 800
 
 Or a numeric variable:
 
 .. code-block:: Python
 
   plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box", color = "petal_width"))
-  
+
+.. image:: images/Scatterplot_Marginal_Numeric.png
+   :width: 800
+
 If points overlap, jitter can be applied. If the default jitter is unsatisfactory, the value can be changed with jitter_sd:
 
 .. code-block:: Python
 
   plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box", color = "species", jitter = True))
-  
+
+.. image:: images/Scatterplot_Marginal_Jitter.png
+   :width: 800
+
 Opacity can also be lowered for points closeby to be more easily seen:
 
 .. code-block:: Python
 
-  plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box", color = "species", jitter = True, opacity = .8))
-  
+  plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box", color = "species", jitter = True, opacity = .5))
+
+.. image:: images/Scatterplot_Marginal_Opacity.png
+   :width: 800
+
 Trendlines can also be added:
 
 .. code-block:: Python
 
   plot(iv.scatterplot(x = "sepal_length", y = "sepal_width", marg_x = "box", marg_y = "box", color = "species", jitter = True, opacity = .8, trendline = "ols"))
-  
+
+.. image:: images/Scatterplot_Marginal_Trendline.png
+   :width: 800
+
 =======================
 Histogram and Bar Plots
 =======================
@@ -97,10 +120,16 @@ A basic bar plot can be created by using a numeric variable:
 .. code-block:: Python
 
   plot(iv.histogram(x = "sepal_length"))   
-  
+
+.. image:: images/Barplot_Basic.png
+   :width: 800
+
 A basic histogram can be created by using a categorical variable:
 
 .. code-block:: Python
 
   plot(iv.histogram(x = "species"))
-  
+
+.. image:: images/Histogram_Basic.png
+   :width: 800
+
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/source/interactive_visuals.html b/docs/_build/html/source/interactive_visuals.html
@@ -198,14 +198,15 @@
 
 <dl class="py method">
 <dt id="interactive_visuals.Interactive_Visuals.histogram">
-<code class="sig-name descname"><span class="pre">histogram</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Predictor'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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>, <em class="sig-param"><span class="n"><span class="pre">facet_col</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">facet_row</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marginal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ggplot2'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#interactive_visuals.Interactive_Visuals.histogram" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname"><span class="pre">histogram</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Predictor'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_horizontal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</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>, <em class="sig-param"><span class="n"><span class="pre">facet_col</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">facet_row</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marginal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ggplot2'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#interactive_visuals.Interactive_Visuals.histogram" title="Permalink to this definition">¶</a></dt>
 <dd><p>Creates a Plotly histogram. Plotly histograms can work with both numeric and categorical data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>df</strong> (<em>Dataframe</em>) – Required. A Pandas dataframe for plotting the data.</p></li>
-<li><p><strong>x</strong> (<em>str</em>) – Required. The name of a <strong>numeric</strong> variable in the data frame you want to be your predictor.</p></li>
+<li><p><strong>x</strong> (<em>str</em>) – Required. The name of a variable in the data frame you want to be your predictor.</p></li>
 <li><p><strong>y</strong> (<em>str</em>) – Optional, default None.</p></li>
+<li><p><strong>is_horizontal</strong> (<em>bool</em>) – Optional, default False. Will swap x and y values so that the plot appears horizontally.</p></li>
 <li><p><strong>color</strong> (<em>str</em>) – Optional; default None. A factor variable that you want to visualize your histogram.</p></li>
 <li><p><strong>facet_col</strong> (<em>str</em>) – Optional; default None. A factor variable you want to facet your histogram on vertically.</p></li>
 <li><p><strong>facet_row</strong> (<em>str</em>) – Optional; default None. A factor variable you want to facet your histogram on horizontally.</p></li>

diff --git a/docs/_build/html/source/utils.html b/docs/_build/html/source/utils.html
@@ -38,6 +38,7 @@
 
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="Vignette" href="vignette.html" />
     <link rel="prev" title="interactive_visuals module" href="interactive_visuals.html" /> 
 </head>
 
@@ -86,6 +87,7 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="interactive_visuals.html">interactive_visuals module</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">utils module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vignette.html">Vignette</a></li>
 </ul>
 
 
@@ -172,6 +174,7 @@
           </div>
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+        <a href="vignette.html" class="btn btn-neutral float-right" title="Vignette" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
         <a href="interactive_visuals.html" class="btn btn-neutral float-left" title="interactive_visuals module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>