😎 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.

346 lines
16KB

  1. <!-- Generated by pkgdown: do not edit by hand -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>A Plot Theme for ggplot2 by xaringanthemer — theme_xaringan • xaringanthemer</title>
  9. <!-- favicons -->
  10. <link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
  11. <link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
  12. <link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png" />
  13. <link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png" />
  14. <link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png" />
  15. <link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png" />
  16. <!-- jquery -->
  17. <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
  18. <!-- Bootstrap -->
  19. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
  20. <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
  21. <!-- bootstrap-toc -->
  22. <link rel="stylesheet" href="../bootstrap-toc.css">
  23. <script src="../bootstrap-toc.js"></script>
  24. <!-- Font Awesome icons -->
  25. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
  26. <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" />
  27. <!-- clipboard.js -->
  28. <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
  29. <!-- headroom.js -->
  30. <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>
  31. <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
  32. <!-- pkgdown -->
  33. <link href="../pkgdown.css" rel="stylesheet">
  34. <script src="../pkgdown.js"></script>
  35. <link href="../extra.css" rel="stylesheet">
  36. <meta property="og:title" content="A Plot Theme for ggplot2 by xaringanthemer — theme_xaringan" />
  37. <meta property="og:description" content="
  38. Creates ggplot2 themes to match the xaringanthemer theme used in the
  39. xaringan slides that seamlessly matches the &quot;normal&quot; slide colors and
  40. styles. See vignette(&quot;ggplot2-themes&quot;) for more information and examples." />
  41. <meta property="og:image" content="https://pkg.garrickadenbuie.com/xaringanthemer/logo.png" />
  42. <meta name="twitter:card" content="summary" />
  43. <meta name="twitter:creator" content="@grrrck" />
  44. <meta name="twitter:site" content="@grrrck" />
  45. <!-- mathjax -->
  46. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
  47. <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>
  48. <!--[if lt IE 9]>
  49. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  50. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  51. <![endif]-->
  52. </head>
  53. <body data-spy="scroll" data-target="#toc">
  54. <div class="container template-reference-topic">
  55. <header>
  56. <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  57. <div class="container">
  58. <div class="navbar-header">
  59. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
  60. <span class="sr-only">Toggle navigation</span>
  61. <span class="icon-bar"></span>
  62. <span class="icon-bar"></span>
  63. <span class="icon-bar"></span>
  64. </button>
  65. <span class="navbar-brand">
  66. <a class="navbar-link" href="../index.html">xaringanthemer</a>
  67. <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.3.3</span>
  68. </span>
  69. </div>
  70. <div id="navbar" class="navbar-collapse collapse">
  71. <ul class="nav navbar-nav">
  72. <li>
  73. <a href="../articles/xaringanthemer.html">Features</a>
  74. </li>
  75. <li>
  76. <a href="../reference/index.html">Reference</a>
  77. </li>
  78. <li>
  79. <a href="../articles/themes.html">Themes</a>
  80. </li>
  81. <li>
  82. <a href="../articles/ggplot2-themes.html">ggplot2 Themes</a>
  83. </li>
  84. <li class="dropdown">
  85. <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
  86. More
  87. <span class="caret"></span>
  88. </a>
  89. <ul class="dropdown-menu" role="menu">
  90. <li>
  91. <a href="../articles/fonts.html">Fonts</a>
  92. </li>
  93. <li>
  94. <a href="../articles/template-variables.html">Template Variables</a>
  95. </li>
  96. </ul>
  97. </li>
  98. </ul>
  99. <ul class="nav navbar-nav navbar-right">
  100. <li class="dropdown">
  101. <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
  102. <span class="far fa-newspaper fa-lg"></span>
  103. <span class="caret"></span>
  104. </a>
  105. <ul class="dropdown-menu" role="menu">
  106. <li>
  107. <a href="https://garrickadenbuie.com/blog/xaringanthemer-v0-3-0/">xaringan 0.3.0</a>
  108. </li>
  109. <li class="divider"></li>
  110. <li>
  111. <a href="../news/index.html">Changelog</a>
  112. </li>
  113. </ul>
  114. </li>
  115. <li>
  116. <a href="https://github.com/gadenbuie/xaringanthemer">
  117. <span class="fab fa-github fa-lg"></span>
  118. </a>
  119. </li>
  120. <li>
  121. <a href="https://twitter.com/grrrck">
  122. <span class="fab fa-twitter fa-lg"></span>
  123. </a>
  124. </li>
  125. <li>
  126. <a href="https://www.garrickadenbuie.com">
  127. <span class="fas fa-home fa-lg"></span>
  128. </a>
  129. </li>
  130. </ul>
  131. </div><!--/.nav-collapse -->
  132. </div><!--/.container -->
  133. </div><!--/.navbar -->
  134. </header>
  135. <div class="row">
  136. <div class="col-md-9 contents">
  137. <div class="page-header">
  138. <h1>A Plot Theme for ggplot2 by xaringanthemer</h1>
  139. <small class="dont-index">Source: <a href='https://github.com/gadenbuie/xaringanthemer/blob/master/R/ggplot2.R'><code>R/ggplot2.R</code></a></small>
  140. <div class="hidden name"><code>theme_xaringan.Rd</code></div>
  141. </div>
  142. <div class="ref-description">
  143. <p><a href='https://lifecycle.r-lib.org/articles/stages.html#maturing'><img src='figures/lifecycle-maturing.svg' alt='[Maturing]' /></a></p>
  144. <p>Creates <span class="pkg">ggplot2</span> themes to match the xaringanthemer theme used in the
  145. <span class="pkg">xaringan</span> slides that seamlessly matches the "normal" slide colors and
  146. styles. See <code><a href='../articles/ggplot2-themes.html'>vignette("ggplot2-themes")</a></code> for more information and examples.</p>
  147. </div>
  148. <pre class="usage"><span class='fu'>theme_xaringan</span><span class='op'>(</span>
  149. text_color <span class='op'>=</span> <span class='cn'>NULL</span>,
  150. background_color <span class='op'>=</span> <span class='cn'>NULL</span>,
  151. accent_color <span class='op'>=</span> <span class='cn'>NULL</span>,
  152. accent_secondary_color <span class='op'>=</span> <span class='cn'>NULL</span>,
  153. css_file <span class='op'>=</span> <span class='cn'>NULL</span>,
  154. set_ggplot_defaults <span class='op'>=</span> <span class='cn'>TRUE</span>,
  155. text_font <span class='op'>=</span> <span class='cn'>NULL</span>,
  156. text_font_use_google <span class='op'>=</span> <span class='cn'>NULL</span>,
  157. text_font_size <span class='op'>=</span> <span class='cn'>NULL</span>,
  158. title_font <span class='op'>=</span> <span class='cn'>NULL</span>,
  159. title_font_use_google <span class='op'>=</span> <span class='cn'>NULL</span>,
  160. title_font_size <span class='op'>=</span> <span class='cn'>NULL</span>,
  161. use_showtext <span class='op'>=</span> <span class='cn'>TRUE</span>
  162. <span class='op'>)</span></pre>
  163. <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
  164. <table class="ref-arguments">
  165. <colgroup><col class="name" /><col class="desc" /></colgroup>
  166. <tr>
  167. <th>text_color</th>
  168. <td><p>Color for text and foreground, inherits from <code>text_color</code></p></td>
  169. </tr>
  170. <tr>
  171. <th>background_color</th>
  172. <td><p>Color for background, inherits from
  173. <code>background_color</code></p></td>
  174. </tr>
  175. <tr>
  176. <th>accent_color</th>
  177. <td><p>Color for titles and accents, inherits from
  178. <code>header_color</code></p></td>
  179. </tr>
  180. <tr>
  181. <th>accent_secondary_color</th>
  182. <td><p>Color for secondary accents, inherits from
  183. <code>text_bold_color</code></p></td>
  184. </tr>
  185. <tr>
  186. <th>css_file</th>
  187. <td><p>Path to a <span class="pkg">xaringanthemer</span> CSS file, from which the
  188. theme variables and values will be inferred. In general, if you use the
  189. <span class="pkg">xaringathemer</span> defaults, you will not need to set this. This feature
  190. lets you create a <span class="pkg">ggplot2</span> theme for your <span class="pkg">xaringan</span> slides, even
  191. if you have only saved your theme CSS file and you aren't creating your
  192. CSS theme with <span class="pkg">xaringanthemer</span> in your slides' source file.</p></td>
  193. </tr>
  194. <tr>
  195. <th>set_ggplot_defaults</th>
  196. <td><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?
  197. Defaults to TRUE. To restore ggplot's defaults, or the previously set geom
  198. defaults, see <code><a href='theme_xaringan_set_defaults.html'>theme_xaringan_restore_defaults()</a></code>.</p></td>
  199. </tr>
  200. <tr>
  201. <th>text_font</th>
  202. <td><p>Font to use for text elements, passed to
  203. <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
  204. <code>TRUE</code>. Inherits from <code>text_font_family</code>. If manually specified, can be a
  205. <code><a href='google_font.html'>google_font()</a></code>.</p></td>
  206. </tr>
  207. <tr>
  208. <th>text_font_use_google</th>
  209. <td><p>Is <code>text_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></td>
  210. </tr>
  211. <tr>
  212. <th>text_font_size</th>
  213. <td><p>Base text font size, inherits from <code>text_font_size</code>, or
  214. defaults to 11.</p></td>
  215. </tr>
  216. <tr>
  217. <th>title_font</th>
  218. <td><p>Font to use for title elements, passed to
  219. <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
  220. <code>TRUE</code>. Inherits from <code>title_font_family</code>. If manually specified, can be a
  221. <code><a href='google_font.html'>google_font()</a></code>.</p></td>
  222. </tr>
  223. <tr>
  224. <th>title_font_use_google</th>
  225. <td><p>Is <code>title_font</code> available on <a href='https://fonts.google.com'>Google Fonts</a>?</p></td>
  226. </tr>
  227. <tr>
  228. <th>title_font_size</th>
  229. <td><p>Base text font size, inherits from <code>title_font_size</code>,
  230. or defaults to 14.</p></td>
  231. </tr>
  232. <tr>
  233. <th>use_showtext</th>
  234. <td><p>If <code>TRUE</code> (default) the <span class="pkg">showtext</span> package will be
  235. used to register Google fonts. Set to <code>FALSE</code> to disable this feature
  236. entirely, which may result in errors during plotting if the fonts used are
  237. not available locally.</p></td>
  238. </tr>
  239. </table>
  240. <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
  241. <p>A ggplot2 theme</p>
  242. <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
  243. <div class='dont-index'><p>Other xaringanthemer ggplot2 themes:
  244. <code><a href='theme_xaringan_base.html'>theme_xaringan_base</a>()</code>,
  245. <code><a href='theme_xaringan_inverse.html'>theme_xaringan_inverse</a>()</code>,
  246. <code><a href='theme_xaringan_set_defaults.html'>theme_xaringan_set_defaults</a>()</code></p></div>
  247. <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
  248. <pre class="examples"><div class='input'><span class='co'># Requires ggplot2</span>
  249. <span class='va'>has_ggplot2</span> <span class='op'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/ns-load.html'>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>
  250. <span class='kw'>if</span> <span class='op'>(</span><span class='va'>has_ggplot2</span><span class='op'>)</span> <span class='op'>{</span>
  251. <span class='co'># Because this is an example, we'll save the CSS to a temp file</span>
  252. <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'>tempfile</a></span><span class='op'>(</span>fileext <span class='op'>=</span> <span class='st'>".css"</span><span class='op'>)</span>
  253. <span class='co'># Create the xaringan theme: dark blue background with teal green accents</span>
  254. <span class='fu'><a href='style_duo.html'>style_duo</a></span><span class='op'>(</span>
  255. primary_color <span class='op'>=</span> <span class='st'>"#002b36"</span>,
  256. secondary_color <span class='op'>=</span> <span class='st'>"#31b09e"</span>,
  257. <span class='co'># Using basic fonts for this example, but the plot theme will</span>
  258. <span class='co'># automatically use your theme font if you use Google fonts</span>
  259. text_font_family <span class='op'>=</span> <span class='st'>"sans"</span>,
  260. header_font_family <span class='op'>=</span> <span class='st'>"serif"</span>,
  261. outfile <span class='op'>=</span> <span class='va'>path_to_css_file</span>
  262. <span class='op'>)</span>
  263. <span class='kw'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='op'>(</span><span class='va'><a href='https://ggplot2.tidyverse.org'>ggplot2</a></span><span class='op'>)</span>
  264. <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot</a></span><span class='op'>(</span><span class='va'>mpg</span><span class='op'>)</span> <span class='op'>+</span>
  265. <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/aes.html'>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>
  266. <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/geom_point.html'>geom_point</a></span><span class='op'>(</span><span class='op'>)</span> <span class='op'>+</span>
  267. <span class='fu'><a href='https://ggplot2.tidyverse.org/reference/labs.html'>ggtitle</a></span><span class='op'>(</span><span class='st'>"Fuel Efficiency of Various Cars"</span><span class='op'>)</span> <span class='op'>+</span>
  268. <span class='fu'>theme_xaringan</span><span class='op'>(</span><span class='op'>)</span>
  269. <span class='op'>}</span>
  270. </div><div class='img'><img src='theme_xaringan-1.png' alt='' width='700' height='433' /></div></pre>
  271. </div>
  272. <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
  273. <nav id="toc" data-toggle="toc" class="sticky-top">
  274. <h2 data-toc-skip>Contents</h2>
  275. </nav>
  276. </div>
  277. </div>
  278. <footer>
  279. <div class="copyright">
  280. <p>Developed by <a href='https://www.garrickadenbuie.com'>Garrick Aden-Buie</a>.</p>
  281. </div>
  282. <div class="pkgdown">
  283. <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
  284. </div>
  285. </footer>
  286. </div>
  287. </body>
  288. </html>