garrick
/
xaringanthemer
kopia lustrzana https://github.com/gadenbuie/xaringanthemer.git
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Wydania 10 Wiki Aktywność
😎 Give your xaringan slides some style
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
517 Commity
5 Gałęzie
Drzewo: c112855b3f
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'c112855b3f'
${ noResults }
xaringanthemer/dev/reference/theme_xaringan.html

221 lines
18KB
Czysty Wina Historia 

  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>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.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="A Plot Theme for ggplot2 by xaringanthemer — theme_xaringan"><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.'><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"></head><body>

  9.     <a href="#main" class="visually-hidden-focusable">Skip to contents</a>

  10. 

  11. 

  12.     <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

  13. 

  14.     <a class="navbar-brand me-2" href="../index.html">xaringanthemer</a>

  15. 

  16.     <small class="nav-text text-danger me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="In-development version">0.4.2.9000</small>

  17. 

  18. 

  19.     <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">

  20.       <span class="navbar-toggler-icon"></span>

  21.     </button>

  22. 

  23.     <div id="navbar" class="collapse navbar-collapse ms-3">

  24.       <ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/xaringanthemer.html">Features</a></li>

  25. <li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>

  26. <li class="nav-item dropdown">

  27.   <button class="nav-link dropdown-toggle" type="button" id="dropdown-themes" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Themes</button>

  28.   <ul class="dropdown-menu" aria-labelledby="dropdown-themes"><li><h6 class="dropdown-header" data-toc-skip>Themes</h6></li>

  29.     <li><a class="dropdown-item" href="../articles/themes.html">Slide Themes</a></li>

  30.     <li><a class="dropdown-item" href="../articles/ggplot2-themes.html">ggplot2 Themes</a></li>

  31.     <li><hr class="dropdown-divider"></li>

  32.     <li><h6 class="dropdown-header" data-toc-skip>More Customization</h6></li>

  33.     <li><a class="dropdown-item" href="../articles/fonts.html">Fonts</a></li>

  34.     <li><a class="dropdown-item" href="../articles/template-variables.html">Template Variables</a></li>

  35.   </ul></li>

  36.       </ul><ul class="navbar-nav"><li class="nav-item dropdown">

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

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

  39.     <li><hr class="dropdown-divider"></li>

  40.     <li><a class="dropdown-item" href="../news/index.html">Changelog</a></li>

  41.   </ul></li>

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

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

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

  45.       </ul></div>

  46. 

  47. 

  48.   </div>

  49. </nav><div class="container template-reference-topic">

  50. <div class="row">

  51.   <main id="main" class="col-md-9"><div class="page-header">

  52.       <img src="../logo.png" class="logo" alt=""><h1>A Plot Theme for ggplot2 by xaringanthemer</h1>

  53.       <small class="dont-index">Source: <a href="https://github.com/gadenbuie/xaringanthemer/blob/main/R/ggplot2.R" class="external-link"><code>R/ggplot2.R</code></a></small>

  54.       <div class="d-none name"><code>theme_xaringan.Rd</code></div>

  55.     </div>

  56. 

  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>Creates <span class="pkg">ggplot2</span> themes to match the xaringanthemer theme used in the

  60. <span class="pkg">xaringan</span> slides that seamlessly matches the "normal" slide colors and

  61. styles. See <code><a href="../articles/ggplot2-themes.html">vignette("ggplot2-themes")</a></code> for more information and examples.</p>

  62.     </div>

  63. 

  64.     <div class="section level2">

  65.     <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>

  66.     <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_xaringan</span><span class="op">(</span></span>

  67. <span>  text_color <span class="op">=</span> <span class="cn">NULL</span>,</span>

  68. <span>  background_color <span class="op">=</span> <span class="cn">NULL</span>,</span>

  69. <span>  accent_color <span class="op">=</span> <span class="cn">NULL</span>,</span>

  70. <span>  accent_secondary_color <span class="op">=</span> <span class="cn">NULL</span>,</span>

  71. <span>  css_file <span class="op">=</span> <span class="cn">NULL</span>,</span>

  72. <span>  set_ggplot_defaults <span class="op">=</span> <span class="cn">TRUE</span>,</span>

  73. <span>  text_font <span class="op">=</span> <span class="cn">NULL</span>,</span>

  74. <span>  text_font_use_google <span class="op">=</span> <span class="cn">NULL</span>,</span>

  75. <span>  text_font_size <span class="op">=</span> <span class="cn">NULL</span>,</span>

  76. <span>  title_font <span class="op">=</span> <span class="cn">NULL</span>,</span>

  77. <span>  title_font_use_google <span class="op">=</span> <span class="cn">NULL</span>,</span>

  78. <span>  title_font_size <span class="op">=</span> <span class="cn">NULL</span>,</span>

  79. <span>  use_showtext <span class="op">=</span> <span class="cn">NULL</span></span>

  80. <span><span class="op">)</span></span></code></pre></div>

  81.     </div>

  82. 

  83.     <div class="section level2">

  84.     <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>

  85. 

  86. 

  87. <dl><dt id="arg-text-color">text_color<a class="anchor" aria-label="anchor" href="#arg-text-color"></a></dt>

  88. <dd><p>Color for text and foreground, inherits from <code>text_color</code></p></dd>

  89. 

  90. 

  91. <dt id="arg-background-color">background_color<a class="anchor" aria-label="anchor" href="#arg-background-color"></a></dt>

  92. <dd><p>Color for background, inherits from

  93. <code>background_color</code></p></dd>

  94. 

  95. 

  96. <dt id="arg-accent-color">accent_color<a class="anchor" aria-label="anchor" href="#arg-accent-color"></a></dt>

  97. <dd><p>Color for titles and accents, inherits from

  98. <code>header_color</code></p></dd>

  99. 

  100. 

  101. <dt id="arg-accent-secondary-color">accent_secondary_color<a class="anchor" aria-label="anchor" href="#arg-accent-secondary-color"></a></dt>

  102. <dd><p>Color for secondary accents, inherits from

  103. <code>text_bold_color</code></p></dd>

  104. 

  105. 

  106. <dt id="arg-css-file">css_file<a class="anchor" aria-label="anchor" href="#arg-css-file"></a></dt>

  107. <dd><p>Path to a <span class="pkg">xaringanthemer</span> CSS file, from which the

  108. theme variables and values will be inferred. In general, if you use the

  109. <span class="pkg">xaringathemer</span> defaults, you will not need to set this. This feature

  110. lets you create a <span class="pkg">ggplot2</span> theme for your <span class="pkg">xaringan</span> slides, even

  111. if you have only saved your theme CSS file and you aren't creating your

  112. CSS theme with <span class="pkg">xaringanthemer</span> in your slides' source file.</p></dd>

  113. 

  114. 

  115. <dt id="arg-set-ggplot-defaults">set_ggplot_defaults<a class="anchor" aria-label="anchor" href="#arg-set-ggplot-defaults"></a></dt>

  116. <dd><p>Should defaults be set for <span class="pkg">ggplot2</span> <em>geoms</em>?

  117. Defaults to TRUE. To restore ggplot's defaults, or the previously set geom

  118. defaults, see <code><a href="theme_xaringan_set_defaults.html">theme_xaringan_restore_defaults()</a></code>.</p></dd>

  119. 

  120. 

  121. <dt id="arg-text-font">text_font<a class="anchor" aria-label="anchor" href="#arg-text-font"></a></dt>

  122. <dd><p>Font to use for text elements, passed to

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

  124. <code>TRUE</code>. Inherits from <code>text_font_family</code>. If manually specified, can be a

  125. <code><a href="google_font.html">google_font()</a></code>.</p></dd>

  126. 

  127. 

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

  129. <dd><p>Is <code>text_font</code> available on <a href="https://fonts.google.com" class="external-link">Google Fonts</a>?</p></dd>

  130. 

  131. 

  132. <dt id="arg-text-font-size">text_font_size<a class="anchor" aria-label="anchor" href="#arg-text-font-size"></a></dt>

  133. <dd><p>Base text font size, inherits from <code>text_font_size</code>, or

  134. defaults to 11.</p></dd>

  135. 

  136. 

  137. <dt id="arg-title-font">title_font<a class="anchor" aria-label="anchor" href="#arg-title-font"></a></dt>

  138. <dd><p>Font to use for title elements, passed to

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

  140. <code>TRUE</code>. Inherits from <code>title_font_family</code>. If manually specified, can be a

  141. <code><a href="google_font.html">google_font()</a></code>.</p></dd>

  142. 

  143. 

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

  145. <dd><p>Is <code>title_font</code> available on <a href="https://fonts.google.com" class="external-link">Google Fonts</a>?</p></dd>

  146. 

  147. 

  148. <dt id="arg-title-font-size">title_font_size<a class="anchor" aria-label="anchor" href="#arg-title-font-size"></a></dt>

  149. <dd><p>Base text font size, inherits from <code>title_font_size</code>,

  150. or defaults to 14.</p></dd>

  151. 

  152. 

  153. <dt id="arg-use-showtext">use_showtext<a class="anchor" aria-label="anchor" href="#arg-use-showtext"></a></dt>

  154. <dd><p>If <code>TRUE</code> the <span class="pkg">showtext</span> package will be

  155. used to register Google fonts. Set to <code>FALSE</code> to disable this feature

  156. entirely, which may result in errors during plotting if the fonts used are

  157. not available locally. The default is <code>TRUE</code> when the <span class="pkg">showtext</span>

  158. package is installed.</p></dd>

  159. 

  160. </dl></div>

  161.     <div class="section level2">

  162.     <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>

  163.     <p>A ggplot2 theme</p>

  164.     </div>

  165.     <div class="section level2">

  166.     <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>

  167.     <div class="dont-index"><p>Other xaringanthemer ggplot2 themes:

  168. <code><a href="theme_xaringan_base.html">theme_xaringan_base</a>()</code>,

  169. <code><a href="theme_xaringan_inverse.html">theme_xaringan_inverse</a>()</code>,

  170. <code><a href="theme_xaringan_set_defaults.html">theme_xaringan_set_defaults</a>()</code></p></div>

  171.     </div>

  172. 

  173.     <div class="section level2">

  174.     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>

  175.     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Requires ggplot2</span></span></span>

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

  177. <span class="r-in"><span></span></span>

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

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

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

  181. <span class="r-in"><span></span></span>

  182. <span class="r-in"><span>  <span class="co"># Create the xaringan theme: dark blue background with teal green accents</span></span></span>

  183. <span class="r-in"><span>  <span class="fu"><a href="style_duo.html">style_duo</a></span><span class="op">(</span></span></span>

  184. <span class="r-in"><span>    primary_color <span class="op">=</span> <span class="st">"#002b36"</span>,</span></span>

  185. <span class="r-in"><span>    secondary_color <span class="op">=</span> <span class="st">"#31b09e"</span>,</span></span>

  186. <span class="r-in"><span>    <span class="co"># Using basic fonts for this example, but the plot theme will</span></span></span>

  187. <span class="r-in"><span>    <span class="co"># automatically use your theme font if you use Google fonts</span></span></span>

  188. <span class="r-in"><span>    text_font_family <span class="op">=</span> <span class="st">"sans"</span>,</span></span>

  189. <span class="r-in"><span>    header_font_family <span class="op">=</span> <span class="st">"serif"</span>,</span></span>

  190. <span class="r-in"><span>    outfile <span class="op">=</span> <span class="va">path_to_css_file</span></span></span>

  191. <span class="r-in"><span>  <span class="op">)</span></span></span>

  192. <span class="r-in"><span></span></span>

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

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

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

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

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

  198. <span class="r-in"><span>    <span class="fu">theme_xaringan</span><span class="op">(</span><span class="op">)</span></span></span>

  199. <span class="r-in"><span><span class="op">}</span></span></span>

  200. <span class="r-plt img"><img src="theme_xaringan-1.png" alt="" width="700" height="433"></span>

  201. </code></pre></div>

  202.     </div>

  203.   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>

  204.     </nav></aside></div>

  205. 

  206. 

  207.     <footer><div class="pkgdown-footer-left">

  208.   <p>Developed by <a href="https://www.garrickadenbuie.com" class="external-link">Garrick Aden-Buie</a>.</p>

  209. </div>

  210. 

  211. <div class="pkgdown-footer-right">

  212.   <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p>

  213. </div>

  214. 

  215.     </footer></div>

  216. 

  217. 

  218. 

  219.   <script src="../doc-versions.js"></script></body></html>