Merge pull request #438 from jakobrunge/developer

Developer

docs/_build/_modules/tigramite/independence_tests/cmiknn.html

@@ -252,7 +252,7 @@ <h1>Source code for tigramite.independence_tests.cmiknn</h1><div class="highligh
 
 <div class="viewcode-block" id="CMIknn.get_dependence_measure">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.cmiknn.CMIknn.get_dependence_measure">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns CMI estimate as described in Frenzel and Pompe PRL (2007).</span>
 
 <span class="sd">        Parameters</span>
@@ -292,7 +292,8 @@ <h1>Source code for tigramite.independence_tests.cmiknn</h1><div class="highligh
 <div class="viewcode-block" id="CMIknn.get_shuffle_significance">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.cmiknn.CMIknn.get_shuffle_significance">[docs]</a>
     <span class="k">def</span> <span class="nf">get_shuffle_significance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span>
-                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> 
+                                 <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns p-value for nearest-neighbor shuffle significance test.</span>
 
 <span class="sd">        For non-empty Z, overwrites get_shuffle_significance from the parent</span>

docs/_build/_modules/tigramite/independence_tests/cmisymb.html

@@ -126,7 +126,7 @@ <h1>Source code for tigramite.independence_tests.cmisymb</h1><div class="highlig
 
 <div class="viewcode-block" id="CMIsymb.get_dependence_measure">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.cmisymb.CMIsymb.get_dependence_measure">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns CMI estimate based on contingency table from scipy&#39;s crosstab</span>
 <span class="sd">        to approximate probability mass.</span>
 
@@ -186,7 +186,8 @@ <h1>Source code for tigramite.independence_tests.cmisymb</h1><div class="highlig
 <div class="viewcode-block" id="CMIsymb.get_shuffle_significance">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.cmisymb.CMIsymb.get_shuffle_significance">[docs]</a>
     <span class="k">def</span> <span class="nf">get_shuffle_significance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span>
-                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+                                 <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns p-value for shuffle significance test.</span>
 
 <span class="sd">        Performes a local permutation test: x_i values are only permuted with</span>

docs/_build/_modules/tigramite/independence_tests/gpdc.html

@@ -565,7 +565,7 @@ <h1>Source code for tigramite.independence_tests.gpdc</h1><div class="highlight"
 
 <div class="viewcode-block" id="GPDC.get_dependence_measure">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.gpdc.GPDC.get_dependence_measure">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return GPDC measure.</span>
 
 <span class="sd">        Estimated as the distance correlation of the residuals of a GP</span>
@@ -621,7 +621,8 @@ <h1>Source code for tigramite.independence_tests.gpdc</h1><div class="highlight"
 <div class="viewcode-block" id="GPDC.get_shuffle_significance">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.gpdc.GPDC.get_shuffle_significance">[docs]</a>
     <span class="k">def</span> <span class="nf">get_shuffle_significance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span>
-                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+                                 <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns p-value for shuffle significance test.</span>
 
 <span class="sd">        For residual-based test statistics only the residuals are shuffled.</span>

docs/_build/_modules/tigramite/independence_tests/gpdc_torch.html

@@ -722,7 +722,7 @@ <h1>Source code for tigramite.independence_tests.gpdc_torch</h1><div class="high
 
 <div class="viewcode-block" id="GPDCtorch.get_dependence_measure">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.gpdc_torch.GPDCtorch.get_dependence_measure">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return GPDC measure.</span>
 
 <span class="sd">        Estimated as the distance correlation of the residuals of a GP</span>
@@ -777,7 +777,8 @@ <h1>Source code for tigramite.independence_tests.gpdc_torch</h1><div class="high
 <div class="viewcode-block" id="GPDCtorch.get_shuffle_significance">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.gpdc_torch.GPDCtorch.get_shuffle_significance">[docs]</a>
     <span class="k">def</span> <span class="nf">get_shuffle_significance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span>
-                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                                 <span class="n">return_null_dist</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+                                 <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns p-value for shuffle significance test.</span>
 
 <span class="sd">        For residual-based test statistics only the residuals are shuffled.</span>

docs/_build/_modules/tigramite/independence_tests/gsquared.html

@@ -111,7 +111,7 @@ <h1>Source code for tigramite.independence_tests.gsquared</h1><div class="highli
 
 <div class="viewcode-block" id="Gsquared.get_dependence_measure">
 <a class="viewcode-back" href="../../../index.html#tigramite.independence_tests.gsquared.Gsquared.get_dependence_measure">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">get_dependence_measure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">array</span><span class="p">,</span> <span class="n">xyz</span><span class="p">,</span> <span class="n">data_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns Gsquared/G-test test statistic.</span>
 
 <span class="sd">        Parameters</span>