😎 Give your xaringan slides some style
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

254 lines
19KB

  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"><meta name="description" content='
  3. Creates ggplot2 themes to match the xaringanthemer theme used in the
  4. xaringan slides that seamlessly matches the "normal" slide colors and
  5. styles. See vignette("ggplot2-themes") for more information and examples.'><title>A Plot Theme for ggplot2 by xaringanthemer — theme_xaringan • 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.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><link href="../deps/IBM_Plex_Mono-0.4.2/font.css" rel="stylesheet"><link href="../deps/Outfit-0.4.2/font.css" rel="stylesheet"><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="A Plot Theme for ggplot2 by xaringanthemer — theme_xaringan"><meta property="og:description" content='
  6. Creates ggplot2 themes to match the xaringanthemer theme used in the
  7. xaringan slides that seamlessly matches the "normal" slide colors and
  8. styles. 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"><meta name="robots" content="noindex"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
  9. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  10. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  11. <![endif]--></head><body>
  12. <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
  13. <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
  14. <a class="navbar-brand me-2" href="../index.html">xaringanthemer</a>
  15. <small class="nav-text text-danger me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="In-development version">0.4.1.9000</small>
  16. <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
  17. <span class="navbar-toggler-icon"></span>
  18. </button>
  19. <div id="navbar" class="collapse navbar-collapse ms-3">
  20. <ul class="navbar-nav me-auto"><li class="nav-item">
  21. <a class="nav-link" href="../articles/xaringanthemer.html">Features</a>
  22. </li>
  23. <li class="active nav-item">
  24. <a class="nav-link" href="../reference/index.html">Reference</a>
  25. </li>
  26. <li class="nav-item dropdown">
  27. <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-themes">Themes</a>
  28. <div class="dropdown-menu" aria-labelledby="dropdown-themes">
  29. <h6 class="dropdown-header" data-toc-skip>Themes</h6>
  30. <a class="dropdown-item" href="../articles/themes.html">Slide Themes</a>
  31. <a class="dropdown-item" href="../articles/ggplot2-themes.html">ggplot2 Themes</a>
  32. <div class="dropdown-divider"></div>
  33. <h6 class="dropdown-header" data-toc-skip>More Customization</h6>
  34. <a class="dropdown-item" href="../articles/fonts.html">Fonts</a>
  35. <a class="dropdown-item" href="../articles/template-variables.html">Template Variables</a>
  36. </div>
  37. </li>
  38. </ul><form class="form-inline my-2 my-lg-0" role="search">
  39. <input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
  40. <ul class="navbar-nav"><li class="nav-item dropdown">
  41. <a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown--">
  42. <span class="far fa far fa-newspaper fa-lg"></span>
  43. </a>
  44. <div class="dropdown-menu" aria-labelledby="dropdown--">
  45. <a class="external-link dropdown-item" href="https://garrickadenbuie.com/blog/xaringanthemer-v0-3-0/">xaringanthemer 0.3.0</a>
  46. <div class="dropdown-divider"></div>
  47. <a class="dropdown-item" href="../news/index.html">Changelog</a>
  48. </div>
  49. </li>
  50. <li class="nav-item">
  51. <a class="external-link nav-link" href="https://github.com/gadenbuie/xaringanthemer">
  52. <span class="fab fa fab fa-github fa-lg"></span>
  53. </a>
  54. </li>
  55. <li class="nav-item">
  56. <a class="external-link nav-link" href="https://twitter.com/grrrck">
  57. <span class="fab fa fab fa-twitter fa-lg"></span>
  58. </a>
  59. </li>
  60. <li class="nav-item">
  61. <a class="external-link nav-link" href="https://www.garrickadenbuie.com">
  62. <span class="fas fa fas fa-home fa-lg"></span>
  63. </a>
  64. </li>
  65. </ul></div>
  66. </div>
  67. </nav><div class="container template-reference-topic">
  68. <div class="row">
  69. <main id="main" class="col-md-9"><div class="page-header">
  70. <img src="../logo.png" class="logo" alt=""><h1>A Plot Theme for ggplot2 by xaringanthemer</h1>
  71. <small class="dont-index">Source: <a href="https://github.com/gadenbuie/xaringanthemer/blob/HEAD/R/ggplot2.R" class="external-link"><code>R/ggplot2.R</code></a></small>
  72. <div class="d-none name"><code>theme_xaringan.Rd</code></div>
  73. </div>
  74. <div class="ref-description section level2">
  75. <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>
  76. <p>Creates <span class="pkg">ggplot2</span> themes to match the xaringanthemer theme used in the
  77. <span class="pkg">xaringan</span> slides that seamlessly matches the "normal" slide colors and
  78. styles. See <code><a href="../articles/ggplot2-themes.html">vignette("ggplot2-themes")</a></code> for more information and examples.</p>
  79. </div>
  80. <div class="section level2">
  81. <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
  82. <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_xaringan</span><span class="op">(</span></span>
  83. <span> text_color <span class="op">=</span> <span class="cn">NULL</span>,</span>
  84. <span> background_color <span class="op">=</span> <span class="cn">NULL</span>,</span>
  85. <span> accent_color <span class="op">=</span> <span class="cn">NULL</span>,</span>
  86. <span> accent_secondary_color <span class="op">=</span> <span class="cn">NULL</span>,</span>
  87. <span> css_file <span class="op">=</span> <span class="cn">NULL</span>,</span>
  88. <span> set_ggplot_defaults <span class="op">=</span> <span class="cn">TRUE</span>,</span>
  89. <span> text_font <span class="op">=</span> <span class="cn">NULL</span>,</span>
  90. <span> text_font_use_google <span class="op">=</span> <span class="cn">NULL</span>,</span>
  91. <span> text_font_size <span class="op">=</span> <span class="cn">NULL</span>,</span>
  92. <span> title_font <span class="op">=</span> <span class="cn">NULL</span>,</span>
  93. <span> title_font_use_google <span class="op">=</span> <span class="cn">NULL</span>,</span>
  94. <span> title_font_size <span class="op">=</span> <span class="cn">NULL</span>,</span>
  95. <span> use_showtext <span class="op">=</span> <span class="cn">NULL</span></span>
  96. <span><span class="op">)</span></span></code></pre></div>
  97. </div>
  98. <div class="section level2">
  99. <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
  100. <dl><dt>text_color</dt>
  101. <dd><p>Color for text and foreground, inherits from <code>text_color</code></p></dd>
  102. <dt>background_color</dt>
  103. <dd><p>Color for background, inherits from
  104. <code>background_color</code></p></dd>
  105. <dt>accent_color</dt>
  106. <dd><p>Color for titles and accents, inherits from
  107. <code>header_color</code></p></dd>
  108. <dt>accent_secondary_color</dt>
  109. <dd><p>Color for secondary accents, inherits from
  110. <code>text_bold_color</code></p></dd>
  111. <dt>css_file</dt>
  112. <dd><p>Path to a <span class="pkg">xaringanthemer</span> CSS file, from which the
  113. theme variables and values will be inferred. In general, if you use the
  114. <span class="pkg">xaringathemer</span> defaults, you will not need to set this. This feature
  115. lets you create a <span class="pkg">ggplot2</span> theme for your <span class="pkg">xaringan</span> slides, even
  116. if you have only saved your theme CSS file and you aren't creating your
  117. CSS theme with <span class="pkg">xaringanthemer</span> in your slides' source file.</p></dd>
  118. <dt>set_ggplot_defaults</dt>
  119. <dd><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
  120. Defaults to TRUE. To restore ggplot's defaults, or the previously set geom
  121. defaults, see <code><a href="theme_xaringan_set_defaults.html">theme_xaringan_restore_defaults()</a></code>.</p></dd>
  122. <dt>text_font</dt>
  123. <dd><p>Font to use for text elements, passed to
  124. <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
  125. <code>TRUE</code>. Inherits from <code>text_font_family</code>. If manually specified, can be a
  126. <code><a href="google_font.html">google_font()</a></code>.</p></dd>
  127. <dt>text_font_use_google</dt>
  128. <dd><p>Is <code>text_font</code> available on <a href="https://fonts.google.com" class="external-link">Google Fonts</a>?</p></dd>
  129. <dt>text_font_size</dt>
  130. <dd><p>Base text font size, inherits from <code>text_font_size</code>, or
  131. defaults to 11.</p></dd>
  132. <dt>title_font</dt>
  133. <dd><p>Font to use for title elements, passed to
  134. <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
  135. <code>TRUE</code>. Inherits from <code>title_font_family</code>. If manually specified, can be a
  136. <code><a href="google_font.html">google_font()</a></code>.</p></dd>
  137. <dt>title_font_use_google</dt>
  138. <dd><p>Is <code>title_font</code> available on <a href="https://fonts.google.com" class="external-link">Google Fonts</a>?</p></dd>
  139. <dt>title_font_size</dt>
  140. <dd><p>Base text font size, inherits from <code>title_font_size</code>,
  141. or defaults to 14.</p></dd>
  142. <dt>use_showtext</dt>
  143. <dd><p>If <code>TRUE</code> the <span class="pkg">showtext</span> package will be
  144. used to register Google fonts. Set to <code>FALSE</code> to disable this feature
  145. entirely, which may result in errors during plotting if the fonts used are
  146. not available locally. The default is <code>TRUE</code> when the <span class="pkg">showtext</span>
  147. package is installed.</p></dd>
  148. </dl></div>
  149. <div class="section level2">
  150. <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
  151. <p>A ggplot2 theme</p>
  152. </div>
  153. <div class="section level2">
  154. <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
  155. <div class="dont-index"><p>Other xaringanthemer ggplot2 themes:
  156. <code><a href="theme_xaringan_base.html">theme_xaringan_base</a>()</code>,
  157. <code><a href="theme_xaringan_inverse.html">theme_xaringan_inverse</a>()</code>,
  158. <code><a href="theme_xaringan_set_defaults.html">theme_xaringan_set_defaults</a>()</code></p></div>
  159. </div>
  160. <div class="section level2">
  161. <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
  162. <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Requires ggplot2</span></span></span>
  163. <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>
  164. <span class="r-in"><span></span></span>
  165. <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>
  166. <span class="r-in"><span> <span class="co"># Because this is an example, we'll save the CSS to a temp file</span></span></span>
  167. <span class="r-in"><span> <span class="va">path_to_css_file</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/tempfile.html" class="external-link">tempfile</a></span><span class="op">(</span>fileext <span class="op">=</span> <span class="st">".css"</span><span class="op">)</span></span></span>
  168. <span class="r-in"><span></span></span>
  169. <span class="r-in"><span> <span class="co"># Create the xaringan theme: dark blue background with teal green accents</span></span></span>
  170. <span class="r-in"><span> <span class="fu"><a href="style_duo.html">style_duo</a></span><span class="op">(</span></span></span>
  171. <span class="r-in"><span> primary_color <span class="op">=</span> <span class="st">"#002b36"</span>,</span></span>
  172. <span class="r-in"><span> secondary_color <span class="op">=</span> <span class="st">"#31b09e"</span>,</span></span>
  173. <span class="r-in"><span> <span class="co"># Using basic fonts for this example, but the plot theme will</span></span></span>
  174. <span class="r-in"><span> <span class="co"># automatically use your theme font if you use Google fonts</span></span></span>
  175. <span class="r-in"><span> text_font_family <span class="op">=</span> <span class="st">"sans"</span>,</span></span>
  176. <span class="r-in"><span> header_font_family <span class="op">=</span> <span class="st">"serif"</span>,</span></span>
  177. <span class="r-in"><span> outfile <span class="op">=</span> <span class="va">path_to_css_file</span></span></span>
  178. <span class="r-in"><span> <span class="op">)</span></span></span>
  179. <span class="r-in"><span></span></span>
  180. <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>
  181. <span class="r-in"><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>
  182. <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>
  183. <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>
  184. <span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/labs.html" class="external-link">ggtitle</a></span><span class="op">(</span><span class="st">"Fuel Efficiency of Various Cars"</span><span class="op">)</span> <span class="op">+</span></span></span>
  185. <span class="r-in"><span> <span class="fu">theme_xaringan</span><span class="op">(</span><span class="op">)</span></span></span>
  186. <span class="r-in"><span><span class="op">}</span></span></span>
  187. <span class="r-plt img"><img src="theme_xaringan-1.png" alt="" width="700" height="433"></span>
  188. </code></pre></div>
  189. </div>
  190. </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
  191. </nav></aside></div>
  192. <footer><div class="pkgdown-footer-left">
  193. <p></p><p>Developed by <a href="https://www.garrickadenbuie.com" class="external-link">Garrick Aden-Buie</a>.</p>
  194. </div>
  195. <div class="pkgdown-footer-right">
  196. <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
  197. </div>
  198. </footer></div>
  199. <script>window.jQuery('.navbar-brand + small').addClass(['badge', 'bg-secondary', 'text-light']).removeClass('text-muted')</script></body></html>