😎 Give your xaringan slides some style
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

253 satır
22KB

  1. <!DOCTYPE html>
  2. <!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>The ggplot2 xaringanthemer base plot theme — theme_xaringan_base • xaringanthemer</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/IBM_Plex_Mono-0.4.9/font.css" rel="stylesheet"><link href="../deps/Outfit-0.4.9/font.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="The ggplot2 xaringanthemer base plot theme — theme_xaringan_base"><meta name="description" content='
  3. Provides a base plot theme for ggplot2 to match the xaringan
  4. slide theme created by xaringanthemer. The theme is designed to create a
  5. general plot style from two colors, a background_color and a text_color
  6. (or foreground color). Also accepts an accent_color and an
  7. accent_secondary_color that are xaringanthemer is not required for the
  8. base theme. Use theme_xaringan() or theme_xaringan_inverse() in xaringan
  9. slides styled by xaringanthemer for a plot theme that matches the slide
  10. style. See vignette("ggplot2-themes") for more information and examples.'><meta property="og:description" content='
  11. Provides a base plot theme for ggplot2 to match the xaringan
  12. slide theme created by xaringanthemer. The theme is designed to create a
  13. general plot style from two colors, a background_color and a text_color
  14. (or foreground color). Also accepts an accent_color and an
  15. accent_secondary_color that are xaringanthemer is not required for the
  16. base theme. Use theme_xaringan() or theme_xaringan_inverse() in xaringan
  17. slides styled by xaringanthemer for a plot theme that matches the slide
  18. style. See vignette("ggplot2-themes") for more information and examples.'><meta property="og:image" content="https://pkg.garrickadenbuie.com/xaringanthemer/logo.png"><meta name="twitter:card" content="summary"><meta name="twitter:creator" content="@grrrck"><meta name="twitter:site" content="@grrrck"></head><body>
  19. <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
  20. <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
  21. <a class="navbar-brand me-2" href="../index.html">xaringanthemer</a>
  22. <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">0.4.3</small>
  23. <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
  24. <span class="navbar-toggler-icon"></span>
  25. </button>
  26. <div id="navbar" class="collapse navbar-collapse ms-3">
  27. <ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/xaringanthemer.html">Features</a></li>
  28. <li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
  29. <li class="nav-item dropdown">
  30. <button class="nav-link dropdown-toggle" type="button" id="dropdown-themes" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Themes</button>
  31. <ul class="dropdown-menu" aria-labelledby="dropdown-themes"><li><h6 class="dropdown-header" data-toc-skip>Themes</h6></li>
  32. <li><a class="dropdown-item" href="../articles/themes.html">Slide Themes</a></li>
  33. <li><a class="dropdown-item" href="../articles/ggplot2-themes.html">ggplot2 Themes</a></li>
  34. <li><hr class="dropdown-divider"></li>
  35. <li><h6 class="dropdown-header" data-toc-skip>More Customization</h6></li>
  36. <li><a class="dropdown-item" href="../articles/fonts.html">Fonts</a></li>
  37. <li><a class="dropdown-item" href="../articles/template-variables.html">Template Variables</a></li>
  38. </ul></li>
  39. </ul><ul class="navbar-nav"><li class="nav-item dropdown">
  40. <button class="nav-link dropdown-toggle" type="button" id="dropdown-" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true"><span class="fa far fa-newspaper fa-lg"></span> </button>
  41. <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="dropdown-"><li><a class="external-link dropdown-item" href="https://garrickadenbuie.com/blog/xaringanthemer-v0-3-0/">xaringanthemer 0.3.0</a></li>
  42. <li><hr class="dropdown-divider"></li>
  43. <li><a class="dropdown-item" href="../news/index.html">Changelog</a></li>
  44. </ul></li>
  45. <li class="nav-item"><a class="external-link nav-link" href="https://github.com/gadenbuie/xaringanthemer"><span class="fa fab fa-github fa-lg"></span></a></li>
  46. <li class="nav-item"><a class="external-link nav-link" href="https://twitter.com/grrrck"><span class="fa fab fa-twitter fa-lg"></span></a></li>
  47. <li class="nav-item"><a class="external-link nav-link" href="https://www.garrickadenbuie.com"><span class="fa fas fa-home fa-lg"></span></a></li>
  48. </ul></div>
  49. </div>
  50. </nav><div class="container template-reference-topic">
  51. <div class="row">
  52. <main id="main" class="col-md-9"><div class="page-header">
  53. <img src="../logo.png" class="logo" alt=""><h1>The ggplot2 xaringanthemer base plot theme</h1>
  54. <small class="dont-index">Source: <a href="https://github.com/gadenbuie/xaringanthemer/blob/v0.4.3/R/ggplot2.R" class="external-link"><code>R/ggplot2.R</code></a></small>
  55. <div class="d-none name"><code>theme_xaringan_base.Rd</code></div>
  56. </div>
  57. <div class="ref-description section level2">
  58. <p><a href="https://lifecycle.r-lib.org/articles/stages.html#maturing" class="external-link"><img src="figures/lifecycle-maturing.svg" alt="[Maturing]"></a></p>
  59. <p>Provides a base plot theme for <span class="pkg">ggplot2</span> to match the <span class="pkg">xaringan</span>
  60. slide theme created by <a href="xaringanthemer-package.html">xaringanthemer</a>. The theme is designed to create a
  61. general plot style from two colors, a <code>background_color</code> and a <code>text_color</code>
  62. (or foreground color). Also accepts an <code>accent_color</code> and an
  63. <code>accent_secondary_color</code> that are <a href="xaringanthemer-package.html">xaringanthemer</a> is not required for the
  64. base theme. Use <code><a href="theme_xaringan.html">theme_xaringan()</a></code> or <code><a href="theme_xaringan_inverse.html">theme_xaringan_inverse()</a></code> in xaringan
  65. slides styled by xaringanthemer for a plot theme that matches the slide
  66. style. See <code><a href="../articles/ggplot2-themes.html">vignette("ggplot2-themes")</a></code> for more information and examples.</p>
  67. </div>
  68. <div class="section level2">
  69. <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
  70. <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_xaringan_base</span><span class="op">(</span></span>
  71. <span> <span class="va">text_color</span>,</span>
  72. <span> <span class="va">background_color</span>,</span>
  73. <span> <span class="va">...</span>,</span>
  74. <span> set_ggplot_defaults <span class="op">=</span> <span class="cn">TRUE</span>,</span>
  75. <span> accent_color <span class="op">=</span> <span class="cn">NULL</span>,</span>
  76. <span> accent_secondary_color <span class="op">=</span> <span class="cn">NULL</span>,</span>
  77. <span> text_font <span class="op">=</span> <span class="cn">NULL</span>,</span>
  78. <span> text_font_use_google <span class="op">=</span> <span class="cn">NULL</span>,</span>
  79. <span> text_font_size <span class="op">=</span> <span class="cn">NULL</span>,</span>
  80. <span> title_font <span class="op">=</span> <span class="cn">NULL</span>,</span>
  81. <span> title_font_use_google <span class="op">=</span> <span class="cn">NULL</span>,</span>
  82. <span> title_font_size <span class="op">=</span> <span class="cn">NULL</span>,</span>
  83. <span> use_showtext <span class="op">=</span> <span class="cn">NULL</span></span>
  84. <span><span class="op">)</span></span></code></pre></div>
  85. </div>
  86. <div class="section level2">
  87. <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
  88. <dl><dt id="arg-text-color">text_color<a class="anchor" aria-label="anchor" href="#arg-text-color"></a></dt>
  89. <dd><p>Color for text and foreground</p></dd>
  90. <dt id="arg-background-color">background_color<a class="anchor" aria-label="anchor" href="#arg-background-color"></a></dt>
  91. <dd><p>Color for background</p></dd>
  92. <dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
  93. <dd><p>Ignored</p></dd>
  94. <dt id="arg-set-ggplot-defaults">set_ggplot_defaults<a class="anchor" aria-label="anchor" href="#arg-set-ggplot-defaults"></a></dt>
  95. <dd><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
  96. Defaults to TRUE. To restore ggplot's defaults, or the previously set geom
  97. defaults, see <code><a href="theme_xaringan_set_defaults.html">theme_xaringan_restore_defaults()</a></code>.</p></dd>
  98. <dt id="arg-accent-color">accent_color<a class="anchor" aria-label="anchor" href="#arg-accent-color"></a></dt>
  99. <dd><p>Color for titles and accents, inherits from
  100. <code>header_color</code> or <code>text_color</code>. Used for the <code>title</code> base setting in
  101. <code><a href="https://ggplot2.tidyverse.org/reference/theme.html" class="external-link">ggplot2::theme()</a></code>, and additionally for setting the <code>color</code> or <code>fill</code> of
  102. <span class="pkg">ggplot2</span> geom defaults.</p></dd>
  103. <dt id="arg-accent-secondary-color">accent_secondary_color<a class="anchor" aria-label="anchor" href="#arg-accent-secondary-color"></a></dt>
  104. <dd><p>Color for secondary accents, inherits from
  105. <code>text_bold_color</code> or <code>accent_color</code>. Used only when setting <span class="pkg">ggplot2</span> geom
  106. defaults.</p></dd>
  107. <dt id="arg-text-font">text_font<a class="anchor" aria-label="anchor" href="#arg-text-font"></a></dt>
  108. <dd><p>Font to use for text elements, passed to
  109. <code><a href="https://rdrr.io/pkg/sysfonts/man/font_add_google.html" class="external-link">sysfonts::font_add_google()</a></code>, if available and <code>text_font_use_google</code> is
  110. <code>TRUE</code>. Inherits from <code>text_font_family</code>. If manually specified, can be a
  111. <code><a href="google_font.html">google_font()</a></code>.</p></dd>
  112. <dt id="arg-text-font-use-google">text_font_use_google<a class="anchor" aria-label="anchor" href="#arg-text-font-use-google"></a></dt>
  113. <dd><p>Is <code>text_font</code> available on <a href="https://fonts.google.com" class="external-link">Google Fonts</a>?</p></dd>
  114. <dt id="arg-text-font-size">text_font_size<a class="anchor" aria-label="anchor" href="#arg-text-font-size"></a></dt>
  115. <dd><p>Base text font size, inherits from <code>text_font_size</code>, or
  116. defaults to 11.</p></dd>
  117. <dt id="arg-title-font">title_font<a class="anchor" aria-label="anchor" href="#arg-title-font"></a></dt>
  118. <dd><p>Font to use for title elements, passed to
  119. <code><a href="https://rdrr.io/pkg/sysfonts/man/font_add_google.html" class="external-link">sysfonts::font_add_google()</a></code>, if available and <code>title_font_use_google</code> is
  120. <code>TRUE</code>. Inherits from <code>title_font_family</code>. If manually specified, can be a
  121. <code><a href="google_font.html">google_font()</a></code>.</p></dd>
  122. <dt id="arg-title-font-use-google">title_font_use_google<a class="anchor" aria-label="anchor" href="#arg-title-font-use-google"></a></dt>
  123. <dd><p>Is <code>title_font</code> available on <a href="https://fonts.google.com" class="external-link">Google Fonts</a>?</p></dd>
  124. <dt id="arg-title-font-size">title_font_size<a class="anchor" aria-label="anchor" href="#arg-title-font-size"></a></dt>
  125. <dd><p>Base text font size, inherits from <code>title_font_size</code>,
  126. or defaults to 14.</p></dd>
  127. <dt id="arg-use-showtext">use_showtext<a class="anchor" aria-label="anchor" href="#arg-use-showtext"></a></dt>
  128. <dd><p>If <code>TRUE</code> the <span class="pkg">showtext</span> package will be
  129. used to register Google fonts. Set to <code>FALSE</code> to disable this feature
  130. entirely, which may result in errors during plotting if the fonts used are
  131. not available locally. The default is <code>TRUE</code> when the <span class="pkg">showtext</span>
  132. package is installed.</p></dd>
  133. </dl></div>
  134. <div class="section level2">
  135. <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
  136. <p>A ggplot2 theme</p>
  137. </div>
  138. <div class="section level2">
  139. <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
  140. <div class="dont-index"><p>Other xaringanthemer ggplot2 themes:
  141. <code><a href="theme_xaringan.html">theme_xaringan</a>()</code>,
  142. <code><a href="theme_xaringan_inverse.html">theme_xaringan_inverse</a>()</code>,
  143. <code><a href="theme_xaringan_set_defaults.html">theme_xaringan_set_defaults</a>()</code></p></div>
  144. </div>
  145. <div class="section level2">
  146. <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
  147. <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Requires ggplot2</span></span></span>
  148. <span class="r-in"><span><span class="va">has_ggplot2</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/ns-load.html" class="external-link">requireNamespace</a></span><span class="op">(</span><span class="st">"ggplot2"</span>, quietly <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
  149. <span class="r-in"><span></span></span>
  150. <span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="va">has_ggplot2</span><span class="op">)</span> <span class="op">{</span></span></span>
  151. <span class="r-in"><span> <span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a></span><span class="op">)</span></span></span>
  152. <span class="r-in"><span></span></span>
  153. <span class="r-in"><span> <span class="va">plot1</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggplot.html" class="external-link">ggplot</a></span><span class="op">(</span><span class="va">mpg</span><span class="op">)</span> <span class="op">+</span></span></span>
  154. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/aes.html" class="external-link">aes</a></span><span class="op">(</span><span class="va">cty</span>, <span class="va">hwy</span><span class="op">)</span> <span class="op">+</span></span></span>
  155. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_point.html" class="external-link">geom_point</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span></span></span>
  156. <span class="r-in"><span> <span class="fu">theme_xaringan_base</span><span class="op">(</span></span></span>
  157. <span class="r-in"><span> text_color <span class="op">=</span> <span class="st">"#602f6b"</span>, <span class="co"># imperial</span></span></span>
  158. <span class="r-in"><span> background_color <span class="op">=</span> <span class="st">"#f8f8f8"</span>, <span class="co"># light gray</span></span></span>
  159. <span class="r-in"><span> accent_color <span class="op">=</span> <span class="st">"#317873"</span>, <span class="co"># myrtle green</span></span></span>
  160. <span class="r-in"><span> title_font <span class="op">=</span> <span class="st">"sans"</span>,</span></span>
  161. <span class="r-in"><span> text_font <span class="op">=</span> <span class="st">"serif"</span>,</span></span>
  162. <span class="r-in"><span> set_ggplot_defaults <span class="op">=</span> <span class="cn">TRUE</span></span></span>
  163. <span class="r-in"><span> <span class="op">)</span> <span class="op">+</span></span></span>
  164. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/labs.html" class="external-link">labs</a></span><span class="op">(</span></span></span>
  165. <span class="r-in"><span> title <span class="op">=</span> <span class="st">"Fuel Efficiency of Various Cars"</span>,</span></span>
  166. <span class="r-in"><span> subtitle <span class="op">=</span> <span class="st">"+ theme_xaringan_base()"</span>,</span></span>
  167. <span class="r-in"><span> caption <span class="op">=</span> <span class="st">"xaringanthemer"</span></span></span>
  168. <span class="r-in"><span> <span class="op">)</span></span></span>
  169. <span class="r-in"><span></span></span>
  170. <span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">plot1</span><span class="op">)</span></span></span>
  171. <span class="r-in"><span></span></span>
  172. <span class="r-in"><span> <span class="va">plot2</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggplot.html" class="external-link">ggplot</a></span><span class="op">(</span><span class="va">mpg</span><span class="op">)</span> <span class="op">+</span></span></span>
  173. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/aes.html" class="external-link">aes</a></span><span class="op">(</span><span class="va">hwy</span><span class="op">)</span> <span class="op">+</span></span></span>
  174. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_histogram.html" class="external-link">geom_histogram</a></span><span class="op">(</span>binwidth <span class="op">=</span> <span class="fl">2</span><span class="op">)</span> <span class="op">+</span></span></span>
  175. <span class="r-in"><span> <span class="fu">theme_xaringan_base</span><span class="op">(</span></span></span>
  176. <span class="r-in"><span> text_color <span class="op">=</span> <span class="st">"#a8a9c8"</span>, <span class="co"># light purple</span></span></span>
  177. <span class="r-in"><span> background_color <span class="op">=</span> <span class="st">"#303163"</span>, <span class="co"># deep slate purple</span></span></span>
  178. <span class="r-in"><span> accent_color <span class="op">=</span> <span class="st">"#ffff99"</span>, <span class="co"># canary yellow</span></span></span>
  179. <span class="r-in"><span> title_font <span class="op">=</span> <span class="st">"sans"</span>,</span></span>
  180. <span class="r-in"><span> text_font <span class="op">=</span> <span class="st">"serif"</span>,</span></span>
  181. <span class="r-in"><span> set_ggplot_defaults <span class="op">=</span> <span class="cn">TRUE</span></span></span>
  182. <span class="r-in"><span> <span class="op">)</span> <span class="op">+</span></span></span>
  183. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/labs.html" class="external-link">labs</a></span><span class="op">(</span></span></span>
  184. <span class="r-in"><span> title <span class="op">=</span> <span class="st">"Highway Fuel Efficiency"</span>,</span></span>
  185. <span class="r-in"><span> subtitle <span class="op">=</span> <span class="st">"+ theme_xaringan_base()"</span>,</span></span>
  186. <span class="r-in"><span> caption <span class="op">=</span> <span class="st">"xaringanthemer"</span></span></span>
  187. <span class="r-in"><span> <span class="op">)</span></span></span>
  188. <span class="r-in"><span></span></span>
  189. <span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">plot2</span><span class="op">)</span></span></span>
  190. <span class="r-in"><span><span class="op">}</span></span></span>
  191. <span class="r-plt img"><img src="theme_xaringan_base-1.png" alt="" width="700" height="433"></span>
  192. <span class="r-plt img"><img src="theme_xaringan_base-2.png" alt="" width="700" height="433"></span>
  193. </code></pre></div>
  194. </div>
  195. </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
  196. </nav></aside></div>
  197. <footer><div class="pkgdown-footer-left">
  198. <p>Developed by <a href="https://www.garrickadenbuie.com" class="external-link">Garrick Aden-Buie</a>.</p>
  199. </div>
  200. <div class="pkgdown-footer-right">
  201. <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p>
  202. </div>
  203. </footer></div>
  204. <script src="../doc-versions.js"></script></body></html>