Deploy from Travis build 33 [ci skip]

Build URL: https://travis-ci.com/gadenbuie/xaringanthemer/builds/150923406
Commit: aa7413b19d

dev/reference/scale_xaringan.html

   
 
 <meta property="og:title" content="Xaringan Themer ggplot2 Scales — scale_xaringan" />
-<meta property="og:description" content="Lifecycle: Experimental.
+<meta property="og:description" content="Lifecycle: Maturing
 Color and fill single-color scales for discrete and continuous values,
 created using the primary accent color of the xaringanthemer styles." />
 <meta name="twitter:card" content="summary" />
     </div>
 
     <div class="ref-description">
-    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#experimental'>Experimental</a>.</p>
+    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#maturing'>Maturing</a></p>
 <p>Color and fill single-color scales for discrete and continuous values,
 created using the primary accent color of the xaringanthemer styles.</p>
     </div>
     <tr>
       <th>...</th>
       <td><p>Arguments passed on to either the <span class="pkg">colorspace</span> scale
-functions — one of <a href='https://rdrr.io/pkg/colorspace/man/scale_colour_discrete_sequential.html'>colorspace::scale_color_discrete_sequential</a>,
-<a href='https://rdrr.io/pkg/colorspace/man/scale_colour_continuous_sequential.html'>colorspace::scale_color_continuous_sequential</a>,
-<a href='https://rdrr.io/pkg/colorspace/man/scale_colour_discrete_sequential.html'>colorspace::scale_fill_discrete_sequential</a>, or
-<a href='https://rdrr.io/pkg/colorspace/man/scale_colour_continuous_sequential.html'>colorspace::scale_fill_continuous_sequential</a> — or to
+functions — one of <a href='http://colorspace.R-Forge.R-project.org//reference/scale_colour_discrete_sequential.html'>colorspace::scale_color_discrete_sequential</a>,
+<a href='http://colorspace.R-Forge.R-project.org//reference/scale_colour_continuous_sequential.html'>colorspace::scale_color_continuous_sequential</a>,
+<a href='http://colorspace.R-Forge.R-project.org//reference/scale_colour_discrete_sequential.html'>colorspace::scale_fill_discrete_sequential</a>, or
+<a href='http://colorspace.R-Forge.R-project.org//reference/scale_colour_continuous_sequential.html'>colorspace::scale_fill_continuous_sequential</a> — or to
 <a href='https://ggplot2.tidyverse.org/reference/continuous_scale.html'>ggplot2::continuous_scale</a> or <a href='https://ggplot2.tidyverse.org/reference/discrete_scale.html'>ggplot2::discrete_scale</a>.</p></td>
     </tr>
     <tr>
     </table>
 
 
+    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
+    <pre class="examples"><div class='input'><span class='co'># Requires ggplot2</span>
+<span class='no'>has_ggplot2</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/ns-load.html'>requireNamespace</a></span>(<span class='st'>"ggplot2"</span>, <span class='kw'>quietly</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
+
+<span class='kw'>if</span> (<span class='no'>has_ggplot2</span>) {
+  <span class='fu'><a href='https://rdrr.io/r/base/library.html'>library</a></span>(<span class='no'>ggplot2</span>)
+  <span class='co'># Saving the theme to a temp file because this is an example</span>
+  <span class='no'>path_to_css_file</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/tempfile.html'>tempfile</a></span>(<span class='kw'>fileext</span> <span class='kw'>=</span> <span class='st'>".css"</span>)
+
+  <span class='co'># Create the xaringan theme: dark blue background with teal green accents</span>
+  <span class='fu'><a href='style_duo.html'>style_duo</a></span>(
+    <span class='kw'>primary_color</span> <span class='kw'>=</span> <span class='st'>"#002b36"</span>,
+    <span class='kw'>secondary_color</span> <span class='kw'>=</span> <span class='st'>"#31b09e"</span>,
+    <span class='co'># Using basic fonts for this example, but the plot theme will</span>
+    <span class='co'># automatically use your theme font if you use Google fonts</span>
+    <span class='kw'>text_font_family</span> <span class='kw'>=</span> <span class='st'>"sans"</span>,
+    <span class='kw'>header_font_family</span> <span class='kw'>=</span> <span class='st'>"serif"</span>,
+    <span class='kw'>outfile</span> <span class='kw'>=</span> <span class='no'>path_to_css_file</span>
+  )
+
+  <span class='co'># Here's some very basic example data</span>
+  <span class='no'>ex</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
+    <span class='kw'>name</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"Couple"</span>, <span class='st'>"Few"</span>, <span class='st'>"Lots"</span>, <span class='st'>"Many"</span>),
+    <span class='kw'>n</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>2</span>, <span class='fl'>3</span>, <span class='fl'>5</span>, <span class='fl'>7</span>)
+  )
+
+  <span class='co'># Fill color scales demo</span>
+  <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot</a></span>(<span class='no'>ex</span>) +
+    <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/aes.html'>aes</a></span>(<span class='no'>name</span>, <span class='no'>n</span>, <span class='kw'>fill</span> <span class='kw'>=</span> <span class='no'>n</span>) +
+    <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/geom_bar.html'>geom_col</a></span>() +
+    <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/labs.html'>ggtitle</a></span>(<span class='st'>"Matching fill scales"</span>) +
+    <span class='co'># themed to match the slides: dark blue background with teal text</span>
+    <span class='fu'><a href='theme_xaringan.html'>theme_xaringan</a></span>() +
+    <span class='co'># Fill color matches teal text</span>
+    <span class='fu'>scale_xaringan_fill_continuous</span>()
+
+  <span class='co'># Color scales demo</span>
+  <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot</a></span>(<span class='no'>ex</span>) +
+    <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/aes.html'>aes</a></span>(<span class='no'>name</span>, <span class='kw'>y</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>color</span> <span class='kw'>=</span> <span class='no'>name</span>) +
+    <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/geom_point.html'>geom_point</a></span>(<span class='kw'>size</span> <span class='kw'>=</span> <span class='fl'>10</span>) +
+    <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/labs.html'>ggtitle</a></span>(<span class='st'>"Matching color scales"</span>) +
+    <span class='co'># themed to match the slides: dark blue background with teal text</span>
+    <span class='fu'><a href='theme_xaringan.html'>theme_xaringan</a></span>() +
+    <span class='co'># Fill color matches teal text</span>
+    <span class='fu'>scale_xaringan_color_discrete</span>(<span class='kw'>direction</span> <span class='kw'>=</span> -<span class='fl'>1</span>)
+}</div><div class='img'><img src='scale_xaringan-1.png' alt='' width='700' height='433' /></div><div class='input'>
+</div></pre>
   </div>
   <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
     <h2>Contents</h2>
     <ul class="nav nav-pills nav-stacked">
       <li><a href="#arguments">Arguments</a></li>
+      <li><a href="#examples">Examples</a></li>
     </ul>
 
   </div>

dev/reference/theme_xaringan.html

   
 
 <meta property="og:title" content="A Plot Theme for ggplot2 by xaringanthemer — theme_xaringan" />
-<meta property="og:description" content="Lifecycle: Experimental.
+<meta property="og:description" content="Lifecycle: Maturing
 Creates ggplot2 themes to match the xaringanthemer theme used in the
 xaringan slides that seamlessly matches the &quot;normal&quot; slide colors and
 styles." />
     </div>
 
     <div class="ref-description">
-    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#experimental'>Experimental</a>.</p>
+    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#maturing'>Maturing</a></p>
 <p>Creates <span class="pkg">ggplot2</span> themes to match the xaringanthemer theme used in the
 <span class="pkg">xaringan</span> slides that seamlessly matches the "normal" slide colors and
 styles.</p>
   <span class='kw'>accent_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
   <span class='kw'>accent_secondary_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
   <span class='kw'>css_file</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
-  <span class='no'>...</span>
+  <span class='kw'>set_ggplot_defaults</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
+  <span class='kw'>text_font</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>text_font_use_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>text_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>title_font</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>title_font_use_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>title_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>use_showtext</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>
 )</pre>
 
     <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
 CSS theme with <span class="pkg">xaringanthemer</span> in your slides' source file.</p></td>
     </tr>
     <tr>
-      <th>...</th>
-      <td><p>Arguments passed on to <code><a href='theme_xaringan_base.html'>theme_xaringan_base</a></code></p><dl class='dl-horizontal'>
-    <dt><code>set_ggplot_defaults</code></dt><dd><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
+      <th>set_ggplot_defaults</th>
+      <td><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
 Defaults to TRUE. To restore ggplot's defaults, or the previously set geom
-defaults, see <code><a href='theme_xaringan_set_defaults.html'>theme_xaringan_restore_defaults()</a></code>.</p></dd>
-    <dt><code>text_font</code></dt><dd><p>Font to use for text elements, passed to
+defaults, see <code><a href='theme_xaringan_set_defaults.html'>theme_xaringan_restore_defaults()</a></code>.</p></td>
+    </tr>
+    <tr>
+      <th>text_font</th>
+      <td><p>Font to use for text elements, passed to
 <code><a href='https://rdrr.io/pkg/sysfonts/man/font_add_google.html'>sysfonts::font_add_google()</a></code>, if available and <code>text_font_use_google</code> is
-<code>TRUE</code>. Inherits from <code>text_font_family</code>.</p></dd>
-    <dt><code>text_font_use_google</code></dt><dd><p>Is <code>text_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></dd>
-    <dt><code>text_font_size</code></dt><dd><p>Base text font size, inherits from <code>text_font_size</code>, or
-defaults to 11.</p></dd>
-    <dt><code>title_font</code></dt><dd><p>Font to use for title elements, passed to
+<code>TRUE</code>. Inherits from <code>text_font_family</code>.</p></td>
+    </tr>
+    <tr>
+      <th>text_font_use_google</th>
+      <td><p>Is <code>text_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></td>
+    </tr>
+    <tr>
+      <th>text_font_size</th>
+      <td><p>Base text font size, inherits from <code>text_font_size</code>, or
+defaults to 11.</p></td>
+    </tr>
+    <tr>
+      <th>title_font</th>
+      <td><p>Font to use for title elements, passed to
 <code><a href='https://rdrr.io/pkg/sysfonts/man/font_add_google.html'>sysfonts::font_add_google()</a></code>, if available and <code>title_font_use_google</code> is
-<code>TRUE</code>. Inherits from <code>title_font_family</code>.</p></dd>
-    <dt><code>title_font_use_google</code></dt><dd><p>Is <code>title_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></dd>
-    <dt><code>title_font_size</code></dt><dd><p>Base text font size, inherits from <code>title_font_size</code>,
-or defaults to 14.</p></dd>
-  
-</dl></td>
+<code>TRUE</code>. Inherits from <code>title_font_family</code>.</p></td>
+    </tr>
+    <tr>
+      <th>title_font_use_google</th>
+      <td><p>Is <code>title_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></td>
+    </tr>
+    <tr>
+      <th>title_font_size</th>
+      <td><p>Base text font size, inherits from <code>title_font_size</code>,
+or defaults to 14.</p></td>
+    </tr>
+    <tr>
+      <th>use_showtext</th>
+      <td><p>If <code>TRUE</code> (default) the <span class="pkg">showtext</span> package will be
+used to register Google fonts. Set to <code>FALSE</code> to disable this feature
+entirely, which may result in errors during plotting if the fonts used are
+not available locally.</p></td>
     </tr>
     </table>
 

dev/reference/theme_xaringan_base.html

   
 
 <meta property="og:title" content="The ggplot2 xaringanthemer base plot theme — theme_xaringan_base" />
-<meta property="og:description" content="Lifecycle: Experimental.
+<meta property="og:description" content="Lifecycle: Maturing
 Provides a base plot theme for ggplot2 to match the xaringan slide theme
 created by xaringanthemer. The theme is designed to create a general plot
 style from two colors, a background_color and a text_color (or foreground
     </div>
 
     <div class="ref-description">
-    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#experimental'>Experimental</a>.</p>
+    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#maturing'>Maturing</a></p>
 <p>Provides a base plot theme for <span class="pkg">ggplot2</span> to match the <span class="pkg">xaringan</span> slide theme
 created by <a href='xaringanthemer-package.html'>xaringanthemer</a>. The theme is designed to create a general plot
 style from two colors, a <code>background_color</code> and a <code>text_color</code> (or foreground
   <span class='kw'>text_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
   <span class='kw'>title_font</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
   <span class='kw'>title_font_use_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
-  <span class='kw'>title_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>
+  <span class='kw'>title_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>use_showtext</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>
 )</pre>
 
     <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
       <th>title_font_size</th>
       <td><p>Base text font size, inherits from <code>title_font_size</code>,
 or defaults to 14.</p></td>
+    </tr>
+    <tr>
+      <th>use_showtext</th>
+      <td><p>If <code>TRUE</code> (default) the <span class="pkg">showtext</span> package will be
+used to register Google fonts. Set to <code>FALSE</code> to disable this feature
+entirely, which may result in errors during plotting if the fonts used are
+not available locally.</p></td>
     </tr>
     </table>
 

dev/reference/theme_xaringan_inverse.html

   
 
 <meta property="og:title" content="An Inverse Plot Theme for ggplot2 by xaringanthemer — theme_xaringan_inverse" />
-<meta property="og:description" content="Lifecycle: Experimental.
+<meta property="og:description" content="Lifecycle: Maturing
 A ggplot2 xaringanthemer plot theme to seamlessly match the &quot;inverse&quot;
 xaringan slide colors and styles as styled by xaringanthemer." />
 <meta name="twitter:card" content="summary" />
     </div>
 
     <div class="ref-description">
-    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#experimental'>Experimental</a>.</p>
+    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#maturing'>Maturing</a></p>
 <p>A <span class="pkg">ggplot2</span> xaringanthemer plot theme to seamlessly match the "inverse"
 <span class="pkg">xaringan</span> slide colors and styles as styled by <a href='xaringanthemer-package.html'>xaringanthemer</a>.</p>
     </div>
   <span class='kw'>accent_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
   <span class='kw'>accent_secondary_color</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
   <span class='kw'>css_file</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
-  <span class='no'>...</span>
+  <span class='kw'>set_ggplot_defaults</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>,
+  <span class='kw'>text_font</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>text_font_use_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>text_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>title_font</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>title_font_use_google</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>title_font_size</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
+  <span class='kw'>use_showtext</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>
 )</pre>
 
     <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
 CSS theme with <span class="pkg">xaringanthemer</span> in your slides' source file.</p></td>
     </tr>
     <tr>
-      <th>...</th>
-      <td><p>Arguments passed on to <code><a href='theme_xaringan_base.html'>theme_xaringan_base</a></code></p><dl class='dl-horizontal'>
-    <dt><code>set_ggplot_defaults</code></dt><dd><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
+      <th>set_ggplot_defaults</th>
+      <td><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
 Defaults to TRUE. To restore ggplot's defaults, or the previously set geom
-defaults, see <code><a href='theme_xaringan_set_defaults.html'>theme_xaringan_restore_defaults()</a></code>.</p></dd>
-    <dt><code>text_font</code></dt><dd><p>Font to use for text elements, passed to
+defaults, see <code><a href='theme_xaringan_set_defaults.html'>theme_xaringan_restore_defaults()</a></code>.</p></td>
+    </tr>
+    <tr>
+      <th>text_font</th>
+      <td><p>Font to use for text elements, passed to
 <code><a href='https://rdrr.io/pkg/sysfonts/man/font_add_google.html'>sysfonts::font_add_google()</a></code>, if available and <code>text_font_use_google</code> is
-<code>TRUE</code>. Inherits from <code>text_font_family</code>.</p></dd>
-    <dt><code>text_font_use_google</code></dt><dd><p>Is <code>text_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></dd>
-    <dt><code>text_font_size</code></dt><dd><p>Base text font size, inherits from <code>text_font_size</code>, or
-defaults to 11.</p></dd>
-    <dt><code>title_font</code></dt><dd><p>Font to use for title elements, passed to
+<code>TRUE</code>. Inherits from <code>text_font_family</code>.</p></td>
+    </tr>
+    <tr>
+      <th>text_font_use_google</th>
+      <td><p>Is <code>text_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></td>
+    </tr>
+    <tr>
+      <th>text_font_size</th>
+      <td><p>Base text font size, inherits from <code>text_font_size</code>, or
+defaults to 11.</p></td>
+    </tr>
+    <tr>
+      <th>title_font</th>
+      <td><p>Font to use for title elements, passed to
 <code><a href='https://rdrr.io/pkg/sysfonts/man/font_add_google.html'>sysfonts::font_add_google()</a></code>, if available and <code>title_font_use_google</code> is
-<code>TRUE</code>. Inherits from <code>title_font_family</code>.</p></dd>
-    <dt><code>title_font_use_google</code></dt><dd><p>Is <code>title_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></dd>
-    <dt><code>title_font_size</code></dt><dd><p>Base text font size, inherits from <code>title_font_size</code>,
-or defaults to 14.</p></dd>
-  
-</dl></td>
+<code>TRUE</code>. Inherits from <code>title_font_family</code>.</p></td>
+    </tr>
+    <tr>
+      <th>title_font_use_google</th>
+      <td><p>Is <code>title_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></td>
+    </tr>
+    <tr>
+      <th>title_font_size</th>
+      <td><p>Base text font size, inherits from <code>title_font_size</code>,
+or defaults to 14.</p></td>
+    </tr>
+    <tr>
+      <th>use_showtext</th>
+      <td><p>If <code>TRUE</code> (default) the <span class="pkg">showtext</span> package will be
+used to register Google fonts. Set to <code>FALSE</code> to disable this feature
+entirely, which may result in errors during plotting if the fonts used are
+not available locally.</p></td>
     </tr>
     </table>
 

dev/reference/theme_xaringan_set_defaults.html

   
 
 <meta property="og:title" content="Set and Restore ggplot2 geom Defaults — theme_xaringan_set_defaults" />
-<meta property="og:description" content="Lifecycle: Experimental.
+<meta property="og:description" content="Lifecycle: Maturing
 Set ggplot2 geom defaults to match theme_xaringan() with
 theme_xaringan_set_defaults() and restore the standard or previously-set
 defaults with theme_xaringan_restore_defaults(). By default,
     </div>
 
     <div class="ref-description">
-    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#experimental'>Experimental</a>.</p>
+    <p><strong>Lifecycle:</strong> <a href='https://www.tidyverse.org/lifecycle/#maturing'>Maturing</a></p>
 <p>Set <span class="pkg">ggplot2</span> <em>geom</em> defaults to match <code><a href='theme_xaringan.html'>theme_xaringan()</a></code> with
 <code>theme_xaringan_set_defaults()</code> and restore the standard or previously-set
 defaults with <code>theme_xaringan_restore_defaults()</code>. By default,