bump + website

vincentarelbundock · Jun 13, 2024 · 3cebaf6 · 3cebaf6
1 parent dbc0664
commit 3cebaf6
Show file tree

Hide file tree

Showing 199 changed files with 4,035 additions and 3,969 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: marginaleffects
 Title: Predictions, Comparisons, Slopes, Marginal Means, and Hypothesis Tests
-Version: 0.20.1.6
+Version: 0.20.1.7
 Authors@R: 
     c(person(given = "Vincent",
              family = "Arel-Bundock",

diff --git a/NEWS.md b/NEWS.md
@@ -7,6 +7,7 @@ New:
 * `hypothesis` accepts formulas like: `ratio ~ sequential | group`
 * Allow reverse binary contrasts: comparisons(mod, variables = list(am = 1:0, vs = 0:1)). Thanks to K. Henry for report #1137.
 * `options(marginaleffects_safe = FALSE)` disables some safety checks and allows unadvisable (but potentially) useful features like *many* pairwise comparisons. Thanks to D.Locke for the feature request.
+* `newdata="balanced"` is a shortcut to produce estimates at combinations of all categorical predictors, holding numeric predictors at their means. Equivalent to `datagrid(grid_type="balanced")`
 
 Misc:
 

diff --git a/altdoc/freeze.rds b/altdoc/freeze.rds
diff --git a/docs/CITATION.html b/docs/CITATION.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/docs/LICENSE.html b/docs/LICENSE.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/docs/NEWS.html b/docs/NEWS.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
@@ -550,6 +550,8 @@ <h2 class="anchored" data-anchor-id="development">Development</h2>
 <ul>
 <li><code>hypothesis</code> accepts formulas like: <code>ratio ~ sequential | group</code></li>
 <li>Allow reverse binary contrasts: comparisons(mod, variables = list(am = 1:0, vs = 0:1)). Thanks to K. Henry for report <a href="https://github.com/vincentarelbundock/marginaleffects/issues/1137">#1137</a>.</li>
+<li><code>options(marginaleffects_safe = FALSE)</code> disables some safety checks and allows unadvisable (but potentially) useful features like <em>many</em> pairwise comparisons. Thanks to D.Locke for the feature request.</li>
+<li><code>newdata="balanced"</code> is a shortcut to produce estimates at combinations of all categorical predictors, holding numeric predictors at their means. Equivalent to <code>datagrid(grid_type="balanced")</code></li>
 </ul>
 <p>Misc:</p>
 <ul>

diff --git a/docs/freeze.rds b/docs/freeze.rds
diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/docs/man/comparisons.html b/docs/man/comparisons.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – comparisons</title>
 <style>
@@ -554,6 +554,7 @@
   <li><a href="#prediction-types" id="toc-prediction-types" class="nav-link" data-scroll-target="#prediction-types">Prediction types</a></li>
   <li><a href="#order-of-operations" id="toc-order-of-operations" class="nav-link" data-scroll-target="#order-of-operations">Order of operations</a></li>
   <li><a href="#parallel-computation" id="toc-parallel-computation" class="nav-link" data-scroll-target="#parallel-computation">Parallel computation</a></li>
+  <li><a href="#global-options" id="toc-global-options" class="nav-link" data-scroll-target="#global-options">Global options</a></li>
   <li><a href="#references" id="toc-references" class="nav-link" data-scroll-target="#references">References</a></li>
   <li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
   </ul>
@@ -660,7 +661,7 @@
 <p>"median": Contrasts at the Median. Contrasts when each predictor is held at its median or mode.</p>
 </li>
 <li>
-<p>"marginalmeans": Contrasts at Marginal Means.</p>
+<p>"balanced": Contrasts evaluated on a balanced grid with every combination of categories and numeric variables held at their means.</p>
 </li>
 <li>
 <p>"tukey": Contrasts at Tukey’s 5 numbers.</p>
@@ -1634,6 +1635,13 @@
 <pre>options(marginaleffects_parallel = FALSE)
 </pre>
 </div>
+</section><section id="global-options" class="level3"><h3 class="anchored" data-anchor-id="global-options">Global options</h3>
+<p>The behavior of <code>marginaleffects</code> functions can be modified by setting global options.</p>
+<p>Disable some safety checks:</p>
+<div class="sourceCode r">
+<pre>options(marginaleffects_safe = FALSE)`
+</pre>
+</div>
 </section><section id="references" class="level3"><h3 class="anchored" data-anchor-id="references">References</h3>
 <ul>
 <li>

diff --git a/docs/man/datagrid.html b/docs/man/datagrid.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – datagrid</title>
 <style>

diff --git a/docs/man/hypotheses.html b/docs/man/hypotheses.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – hypotheses</title>
 <style>

diff --git a/docs/man/inferences.html b/docs/man/inferences.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – inferences</title>
 <style>

diff --git a/docs/man/plot_comparisons.html b/docs/man/plot_comparisons.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – plot_comparisons</title>
 <style>

diff --git a/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-1.png b/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-1.png
diff --git a/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-2.png b/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-2.png
diff --git a/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-3.png b/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-3.png
diff --git a/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-4.png b/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-4.png
diff --git a/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-5.png b/docs/man/plot_comparisons_files/figure-html/unnamed-chunk-1-5.png
diff --git a/docs/man/plot_predictions.html b/docs/man/plot_predictions.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – plot_predictions</title>
 <style>

diff --git a/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-1.png b/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-1.png
diff --git a/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-2.png b/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-2.png
diff --git a/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-3.png b/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-3.png
diff --git a/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-4.png b/docs/man/plot_predictions_files/figure-html/unnamed-chunk-1-4.png
diff --git a/docs/man/plot_slopes.html b/docs/man/plot_slopes.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – plot_slopes</title>
 <style>

diff --git a/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-1.png b/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-1.png
diff --git a/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-2.png b/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-2.png
diff --git a/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-3.png b/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-3.png
diff --git a/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-4.png b/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-4.png
diff --git a/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-5.png b/docs/man/plot_slopes_files/figure-html/unnamed-chunk-1-5.png
diff --git a/docs/man/posterior_draws.html b/docs/man/posterior_draws.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 

diff --git a/docs/man/predictions.html b/docs/man/predictions.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – predictions</title>
 <style>
@@ -553,6 +553,7 @@
   <li><a href="#prediction-types" id="toc-prediction-types" class="nav-link" data-scroll-target="#prediction-types">Prediction types</a></li>
   <li><a href="#order-of-operations" id="toc-order-of-operations" class="nav-link" data-scroll-target="#order-of-operations">Order of operations</a></li>
   <li><a href="#parallel-computation" id="toc-parallel-computation" class="nav-link" data-scroll-target="#parallel-computation">Parallel computation</a></li>
+  <li><a href="#global-options" id="toc-global-options" class="nav-link" data-scroll-target="#global-options">Global options</a></li>
   <li><a href="#references" id="toc-references" class="nav-link" data-scroll-target="#references">References</a></li>
   <li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
   </ul>
@@ -646,19 +647,19 @@
 <p>string:</p>
 <ul>
 <li>
-<p>"mean": Predictions at the Mean. Predictions when each predictor is held at its mean or mode.</p>
+<p>"mean": Predictions evaluated when each predictor is held at its mean or mode.</p>
 </li>
 <li>
-<p>"median": Predictions at the Median. Predictions when each predictor is held at its median or mode.</p>
+<p>"median": Predictions evaluated when each predictor is held at its median or mode.</p>
 </li>
 <li>
-<p>"marginalmeans": Predictions at Marginal Means. See Details section below.</p>
+<p>"balanced": Predictions evaluated on a balanced grid with every combination of categories and numeric variables held at their means.</p>
 </li>
 <li>
-<p>"tukey": Predictions at Tukey’s 5 numbers.</p>
+<p>"tukey": Predictions evaluated at Tukey’s 5 numbers.</p>
 </li>
 <li>
-<p>"grid": Predictions on a grid of representative numbers (Tukey’s 5 numbers and unique values of categorical predictors).</p>
+<p>"grid": Predictions evaluated on a grid of representative numbers (Tukey’s 5 numbers and unique values of categorical predictors).</p>
 </li>
 </ul>
 </li>
@@ -1355,6 +1356,13 @@
 <pre>options(marginaleffects_parallel = FALSE)
 </pre>
 </div>
+</section><section id="global-options" class="level3"><h3 class="anchored" data-anchor-id="global-options">Global options</h3>
+<p>The behavior of <code>marginaleffects</code> functions can be modified by setting global options.</p>
+<p>Disable some safety checks:</p>
+<div class="sourceCode r">
+<pre>options(marginaleffects_safe = FALSE)`
+</pre>
+</div>
 </section><section id="references" class="level3"><h3 class="anchored" data-anchor-id="references">References</h3>
 <ul>
 <li>

diff --git a/docs/man/print.marginaleffects.html b/docs/man/print.marginaleffects.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta charset="utf-8">
-<meta name="generator" content="quarto-1.5.37">
+<meta name="generator" content="quarto-1.5.43">
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 <title>Marginal Effects Zoo – print.marginaleffects</title>
 <style>
@@ -658,27 +658,27 @@
 <div class="sourceCode" id="cb5"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html">print</a></span><span class="op">(</span><span class="va">p</span>, style <span class="op">=</span> <span class="st">"data.frame"</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <div class="cell-output cell-output-stdout">
 <pre><code>  am gear estimate std.error statistic       p.value  s.value conf.low
-1  1    4 26.27500 1.0392747  25.28205 5.032443e-141 466.0606 24.23806
-2  0    3 16.10667 0.7589789  21.22150 6.046968e-100 329.5966 14.61910
-3  0    4 21.05000 1.4697545  14.32212  1.591933e-46 152.1379 18.16933
+1  1    4 26.27500 1.0392746  25.28206 5.032257e-141 466.0607 24.23806
+2  0    3 16.10667 0.7589789  21.22150 6.047015e-100 329.5966 14.61910
+3  0    4 21.05000 1.4697592  14.32207  1.592966e-46 152.1370 18.16932
 4  1    5 21.38000 1.3145900  16.26363  1.788354e-59 195.1551 18.80345
   conf.high
 1  28.31194
 2  17.59424
-3  23.93067
+3  23.93068
 4  23.95655</code></pre>
 </div>
 <div class="sourceCode" id="cb7"><pre class="downlit sourceCode r code-with-copy"><code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/base/data.frame.html">data.frame</a></span><span class="op">(</span><span class="va">p</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <div class="cell-output cell-output-stdout">
 <pre><code>  am gear estimate std.error statistic       p.value  s.value conf.low
-1  1    4 26.27500 1.0392747  25.28205 5.032443e-141 466.0606 24.23806
-2  0    3 16.10667 0.7589789  21.22150 6.046968e-100 329.5966 14.61910
-3  0    4 21.05000 1.4697545  14.32212  1.591933e-46 152.1379 18.16933
+1  1    4 26.27500 1.0392746  25.28206 5.032257e-141 466.0607 24.23806
+2  0    3 16.10667 0.7589789  21.22150 6.047015e-100 329.5966 14.61910
+3  0    4 21.05000 1.4697592  14.32207  1.592966e-46 152.1370 18.16932
 4  1    5 21.38000 1.3145900  16.26363  1.788354e-59 195.1551 18.80345
   conf.high
 1  28.31194
 2  17.59424
-3  23.93067
+3  23.93068
 4  23.95655</code></pre>
 </div>
 </div>