CINXE.COM
Communicate – R for Data Science (2e)
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <meta name="generator" content="quarto-1.6.41"> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> <meta name="author" content="Hadley Wickham, Mine Çetinkaya-Rundel, and Garrett Grolemund"> <title>Communicate – R for Data Science (2e)</title> <style> code{white-space: pre-wrap;} span.smallcaps{font-variant: small-caps;} div.columns{display: flex; gap: min(4vw, 1.5em);} div.column{flex: auto; overflow-x: auto;} div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} ul.task-list{list-style: none;} ul.task-list li input[type="checkbox"] { width: 0.8em; margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */ vertical-align: middle; } </style> <script src="site_libs/quarto-nav/quarto-nav.js"></script> <script src="site_libs/quarto-nav/headroom.min.js"></script> <script src="site_libs/clipboard/clipboard.min.js"></script> <script src="site_libs/quarto-search/autocomplete.umd.js"></script> <script src="site_libs/quarto-search/fuse.min.js"></script> <script src="site_libs/quarto-search/quarto-search.js"></script> <meta name="quarto:offset" content="./"> <link href="./quarto.html" rel="next"> <link href="./base-R.html" rel="prev"> <link href="./cover.jpg" rel="icon" type="image/jpeg"> <script src="site_libs/quarto-html/quarto.js"></script> <script src="site_libs/quarto-html/popper.min.js"></script> <script src="site_libs/quarto-html/tippy.umd.min.js"></script> <script src="site_libs/quarto-html/anchor.min.js"></script> <link href="site_libs/quarto-html/tippy.css" rel="stylesheet"> <link href="site_libs/quarto-html/quarto-syntax-highlighting-48ffa3e5b9d089919c6712c39e5b00f2.css" rel="stylesheet" id="quarto-text-highlighting-styles"> <script src="site_libs/bootstrap/bootstrap.min.js"></script> <link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet"> <link href="site_libs/bootstrap/bootstrap-8ce0fe0cac6e1f664755c487f6c42e13.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light"><script id="quarto-search-options" type="application/json">{ "location": "sidebar", "copy-button": false, "collapse-after": 3, "panel-placement": "start", "type": "textbox", "limit": 50, "keyboard-shortcut": [ "f", "/", "s" ], "show-item-context": false, "language": { "search-no-results-text": "No results", "search-matching-documents-text": "matching documents", "search-copy-link-title": "Copy link to search", "search-hide-matches-text": "Hide additional matches", "search-more-match-text": "more match in this document", "search-more-matches-text": "more matches in this document", "search-clear-button-title": "Clear", "search-text-placeholder": "", "search-detached-cancel-button-title": "Cancel", "search-submit-button-title": "Submit", "search-label": "Search" } }</script><script defer="" data-domain="r4ds.hadley.nz" src="https://plausible.io/js/plausible.js"></script> </head> <body class="nav-sidebar floating"> <div id="quarto-search-results"></div> <header id="quarto-header" class="headroom fixed-top"><nav class="quarto-secondary-nav"><div class="container-fluid d-flex"> <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }"> <i class="bi bi-layout-text-sidebar-reverse"></i> </button> <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./communicate.html">Communicate</a></li></ol></nav> <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }"> </a> <button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();"> <i class="bi bi-search"></i> </button> </div> </nav></header><!-- content --><div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article"> <!-- sidebar --> <nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation floating overflow-auto"><div class="pt-lg-2 mt-2 text-left sidebar-header"> <div class="sidebar-title mb-0 py-0"> <a href="./">R for Data Science (2e)</a> <div class="sidebar-tools-main"> <a href="https://github.com/hadley/r4ds/" title="Source Code" class="quarto-navigation-tool px-1" aria-label="Source Code"><i class="bi bi-github"></i></a> <a href="" class="quarto-reader-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleReader(); return false;" title="Toggle reader mode"> <div class="quarto-reader-toggle-btn"> <i class="bi"></i> </div> </a> </div> </div> </div> <div class="mt-2 flex-shrink-0 align-items-center"> <div class="sidebar-search"> <div id="quarto-search" class="" title="Search"></div> </div> </div> <div class="sidebar-menu-container"> <ul class="list-unstyled mt-1"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./index.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Welcome</span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./preface-2e.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Preface to the second edition</span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./intro.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Introduction</span></a> </div> </li> <li class="sidebar-item sidebar-item-section"> <div class="sidebar-item-container"> <a href="./whole-game.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Whole game</span></a> <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" role="navigation" aria-expanded="true" aria-label="Toggle section"> <i class="bi bi-chevron-right ms-2"></i> </a> </div> <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./data-visualize.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">1</span> <span class="chapter-title">Data visualization</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./workflow-basics.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">2</span> <span class="chapter-title">Workflow: basics</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./data-transform.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">3</span> <span class="chapter-title">Data transformation</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./workflow-style.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">4</span> <span class="chapter-title">Workflow: code style</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./data-tidy.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">5</span> <span class="chapter-title">Data tidying</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./workflow-scripts.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">6</span> <span class="chapter-title">Workflow: scripts and projects</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./data-import.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">7</span> <span class="chapter-title">Data import</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./workflow-help.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">8</span> <span class="chapter-title">Workflow: getting help</span></span></a> </div> </li> </ul> </li> <li class="sidebar-item sidebar-item-section"> <div class="sidebar-item-container"> <a href="./visualize.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Visualize</span></a> <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true" aria-label="Toggle section"> <i class="bi bi-chevron-right ms-2"></i> </a> </div> <ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./layers.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">9</span> <span class="chapter-title">Layers</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./EDA.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">10</span> <span class="chapter-title">Exploratory data analysis</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./communication.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">11</span> <span class="chapter-title">Communication</span></span></a> </div> </li> </ul> </li> <li class="sidebar-item sidebar-item-section"> <div class="sidebar-item-container"> <a href="./transform.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Transform</span></a> <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="true" aria-label="Toggle section"> <i class="bi bi-chevron-right ms-2"></i> </a> </div> <ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./logicals.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">12</span> <span class="chapter-title">Logical vectors</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./numbers.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">13</span> <span class="chapter-title">Numbers</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./strings.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">14</span> <span class="chapter-title">Strings</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./regexps.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">15</span> <span class="chapter-title">Regular expressions</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./factors.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">16</span> <span class="chapter-title">Factors</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./datetimes.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">17</span> <span class="chapter-title">Dates and times</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./missing-values.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">18</span> <span class="chapter-title">Missing values</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./joins.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">19</span> <span class="chapter-title">Joins</span></span></a> </div> </li> </ul> </li> <li class="sidebar-item sidebar-item-section"> <div class="sidebar-item-container"> <a href="./import.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Import</span></a> <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="true" aria-label="Toggle section"> <i class="bi bi-chevron-right ms-2"></i> </a> </div> <ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth1 show"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./spreadsheets.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">20</span> <span class="chapter-title">Spreadsheets</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./databases.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">21</span> <span class="chapter-title">Databases</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./arrow.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">22</span> <span class="chapter-title">Arrow</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./rectangling.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">23</span> <span class="chapter-title">Hierarchical data</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./webscraping.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">24</span> <span class="chapter-title">Web scraping</span></span></a> </div> </li> </ul> </li> <li class="sidebar-item sidebar-item-section"> <div class="sidebar-item-container"> <a href="./program.html" class="sidebar-item-text sidebar-link"> <span class="menu-text">Program</span></a> <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="true" aria-label="Toggle section"> <i class="bi bi-chevron-right ms-2"></i> </a> </div> <ul id="quarto-sidebar-section-5" class="collapse list-unstyled sidebar-section depth1 show"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./functions.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">25</span> <span class="chapter-title">Functions</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./iteration.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">26</span> <span class="chapter-title">Iteration</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./base-R.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">27</span> <span class="chapter-title">A field guide to base R</span></span></a> </div> </li> </ul> </li> <li class="sidebar-item sidebar-item-section"> <div class="sidebar-item-container"> <a href="./communicate.html" class="sidebar-item-text sidebar-link active"> <span class="menu-text">Communicate</span></a> <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="true" aria-label="Toggle section"> <i class="bi bi-chevron-right ms-2"></i> </a> </div> <ul id="quarto-sidebar-section-6" class="collapse list-unstyled sidebar-section depth1 show"> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./quarto.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">28</span> <span class="chapter-title">Quarto</span></span></a> </div> </li> <li class="sidebar-item"> <div class="sidebar-item-container"> <a href="./quarto-formats.html" class="sidebar-item-text sidebar-link"> <span class="menu-text"><span class="chapter-number">29</span> <span class="chapter-title">Quarto formats</span></span></a> </div> </li> </ul> </li> </ul> </div> </nav><div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div> <!-- margin-sidebar --> <div id="quarto-margin-sidebar" class="sidebar margin-sidebar zindex-bottom"> </div> <!-- main --> <main class="content" id="quarto-document-content"><header id="title-block-header" class="quarto-title-block default"><div class="quarto-title"> <h1 class="title"><span id="sec-communicate-intro" class="quarto-section-identifier">Communicate</span></h1> </div> <div class="quarto-title-meta"> </div> </header><p>So far, you’ve learned the tools to get your data into R, tidy it into a form convenient for analysis, and then understand your data through transformation, and visualization. However, it doesn’t matter how great your analysis is unless you can explain it to others: you need to <strong>communicate</strong> your results.</p> <div class="cell"> <div class="cell-output-display"> <div id="fig-ds-communicate" class="quarto-float quarto-figure quarto-figure-center anchored" alt="A diagram displaying the data science cycle with communicate highlighed in blue. "> <figure class="quarto-float quarto-float-fig figure"><div aria-describedby="fig-ds-communicate-caption-0ceaefa1-69ba-4598-a22c-09a6ac19f8ca"> <img src="diagrams/data-science/communicate.png" class="img-fluid figure-img" alt="A diagram displaying the data science cycle with communicate highlighed in blue. " width="535"> </div> <figcaption class="quarto-float-caption-bottom quarto-float-caption quarto-float-fig" id="fig-ds-communicate-caption-0ceaefa1-69ba-4598-a22c-09a6ac19f8ca"> Figure 1: Communication is the final part of the data science process; if you can’t communicate your results to other humans, it doesn’t matter how great your analysis is. </figcaption></figure> </div> </div> </div> <p>Communication is the theme of the following two chapters:</p> <ul> <li><p>In <a href="quarto.html" class="quarto-xref"><span>28 Quarto</span></a>, you will learn about Quarto, a tool for integrating prose, code, and results. You can use Quarto for analyst-to-analyst communication as well as analyst-to-decision-maker communication. Thanks to the power of Quarto formats, you can even use the same document for both purposes.</p></li> <li><p>In <a href="quarto-formats.html" class="quarto-xref"><span>29 Quarto formats</span></a>, you’ll learn a little about the many other varieties of outputs you can produce using Quarto, including dashboards, websites, and books.</p></li> </ul> <p>These chapters focus mostly on the technical mechanics of communication, not the really hard problems of communicating your thoughts to other humans. However, there are lot of other great books about communication, which we’ll point you to at the end of each chapter.</p> </main><!-- /main --><script id="quarto-html-after-body" type="application/javascript"> window.document.addEventListener("DOMContentLoaded", function (event) { const toggleBodyColorMode = (bsSheetEl) => { const mode = bsSheetEl.getAttribute("data-mode"); const bodyEl = window.document.querySelector("body"); if (mode === "dark") { bodyEl.classList.add("quarto-dark"); bodyEl.classList.remove("quarto-light"); } else { bodyEl.classList.add("quarto-light"); bodyEl.classList.remove("quarto-dark"); } } const toggleBodyColorPrimary = () => { const bsSheetEl = window.document.querySelector("link#quarto-bootstrap"); if (bsSheetEl) { toggleBodyColorMode(bsSheetEl); } } toggleBodyColorPrimary(); const icon = ""; const anchorJS = new window.AnchorJS(); anchorJS.options = { placement: 'right', icon: icon }; anchorJS.add('.anchored'); const isCodeAnnotation = (el) => { for (const clz of el.classList) { if (clz.startsWith('code-annotation-')) { return true; } } return false; } const onCopySuccess = function(e) { // button target const button = e.trigger; // don't keep focus button.blur(); // flash "checked" button.classList.add('code-copy-button-checked'); var currentTitle = button.getAttribute("title"); button.setAttribute("title", "Copied!"); let tooltip; if (window.bootstrap) { button.setAttribute("data-bs-toggle", "tooltip"); button.setAttribute("data-bs-placement", "left"); button.setAttribute("data-bs-title", "Copied!"); tooltip = new bootstrap.Tooltip(button, { trigger: "manual", customClass: "code-copy-button-tooltip", offset: [0, -8]}); tooltip.show(); } setTimeout(function() { if (tooltip) { tooltip.hide(); button.removeAttribute("data-bs-title"); button.removeAttribute("data-bs-toggle"); button.removeAttribute("data-bs-placement"); } button.setAttribute("title", currentTitle); button.classList.remove('code-copy-button-checked'); }, 1000); // clear code selection e.clearSelection(); } const getTextToCopy = function(trigger) { const codeEl = trigger.previousElementSibling.cloneNode(true); for (const childEl of codeEl.children) { if (isCodeAnnotation(childEl)) { childEl.remove(); } } return codeEl.innerText; } const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', { text: getTextToCopy }); clipboard.on('success', onCopySuccess); if (window.document.getElementById('quarto-embedded-source-code-modal')) { const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', { text: getTextToCopy, container: window.document.getElementById('quarto-embedded-source-code-modal') }); clipboardModal.on('success', onCopySuccess); } var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//); var mailtoRegex = new RegExp(/^mailto:/); var filterRegex = new RegExp("https:\/\/r4ds\.hadley\.nz\/"); var isInternal = (href) => { return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href); } // Inspect non-navigation links and adorn them if external var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)'); for (var i=0; i<links.length; i++) { const link = links[i]; if (!isInternal(link.href)) { // undo the damage that might have been done by quarto-nav.js in the case of // links that we want to consider external if (link.dataset.originalHref !== undefined) { link.href = link.dataset.originalHref; } } } function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) { const config = { allowHTML: true, maxWidth: 500, delay: 100, arrow: false, appendTo: function(el) { return el.parentElement; }, interactive: true, interactiveBorder: 10, theme: 'quarto', placement: 'bottom-start', }; if (contentFn) { config.content = contentFn; } if (onTriggerFn) { config.onTrigger = onTriggerFn; } if (onUntriggerFn) { config.onUntrigger = onUntriggerFn; } window.tippy(el, config); } const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]'); for (var i=0; i<noterefs.length; i++) { const ref = noterefs[i]; tippyHover(ref, function() { // use id or data attribute instead here let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href'); try { href = new URL(href).hash; } catch {} const id = href.replace(/^#\/?/, ""); const note = window.document.getElementById(id); if (note) { return note.innerHTML; } else { return ""; } }); } const xrefs = window.document.querySelectorAll('a.quarto-xref'); const processXRef = (id, note) => { // Strip column container classes const stripColumnClz = (el) => { el.classList.remove("page-full", "page-columns"); if (el.children) { for (const child of el.children) { stripColumnClz(child); } } } stripColumnClz(note) if (id === null || id.startsWith('sec-')) { // Special case sections, only their first couple elements const container = document.createElement("div"); if (note.children && note.children.length > 2) { container.appendChild(note.children[0].cloneNode(true)); for (let i = 1; i < note.children.length; i++) { const child = note.children[i]; if (child.tagName === "P" && child.innerText === "") { continue; } else { container.appendChild(child.cloneNode(true)); break; } } if (window.Quarto?.typesetMath) { window.Quarto.typesetMath(container); } return container.innerHTML } else { if (window.Quarto?.typesetMath) { window.Quarto.typesetMath(note); } return note.innerHTML; } } else { // Remove any anchor links if they are present const anchorLink = note.querySelector('a.anchorjs-link'); if (anchorLink) { anchorLink.remove(); } if (window.Quarto?.typesetMath) { window.Quarto.typesetMath(note); } if (note.classList.contains("callout")) { return note.outerHTML; } else { return note.innerHTML; } } } for (var i=0; i<xrefs.length; i++) { const xref = xrefs[i]; tippyHover(xref, undefined, function(instance) { instance.disable(); let url = xref.getAttribute('href'); let hash = undefined; if (url.startsWith('#')) { hash = url; } else { try { hash = new URL(url).hash; } catch {} } if (hash) { const id = hash.replace(/^#\/?/, ""); const note = window.document.getElementById(id); if (note !== null) { try { const html = processXRef(id, note.cloneNode(true)); instance.setContent(html); } finally { instance.enable(); instance.show(); } } else { // See if we can fetch this fetch(url.split('#')[0]) .then(res => res.text()) .then(html => { const parser = new DOMParser(); const htmlDoc = parser.parseFromString(html, "text/html"); const note = htmlDoc.getElementById(id); if (note !== null) { const html = processXRef(id, note); instance.setContent(html); } }).finally(() => { instance.enable(); instance.show(); }); } } else { // See if we can fetch a full url (with no hash to target) // This is a special case and we should probably do some content thinning / targeting fetch(url) .then(res => res.text()) .then(html => { const parser = new DOMParser(); const htmlDoc = parser.parseFromString(html, "text/html"); const note = htmlDoc.querySelector('main.content'); if (note !== null) { // This should only happen for chapter cross references // (since there is no id in the URL) // remove the first header if (note.children.length > 0 && note.children[0].tagName === "HEADER") { note.children[0].remove(); } const html = processXRef(null, note); instance.setContent(html); } }).finally(() => { instance.enable(); instance.show(); }); } }, function(instance) { }); } let selectedAnnoteEl; const selectorForAnnotation = ( cell, annotation) => { let cellAttr = 'data-code-cell="' + cell + '"'; let lineAttr = 'data-code-annotation="' + annotation + '"'; const selector = 'span[' + cellAttr + '][' + lineAttr + ']'; return selector; } const selectCodeLines = (annoteEl) => { const doc = window.document; const targetCell = annoteEl.getAttribute("data-target-cell"); const targetAnnotation = annoteEl.getAttribute("data-target-annotation"); const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation)); const lines = annoteSpan.getAttribute("data-code-lines").split(","); const lineIds = lines.map((line) => { return targetCell + "-" + line; }) let top = null; let height = null; let parent = null; if (lineIds.length > 0) { //compute the position of the single el (top and bottom and make a div) const el = window.document.getElementById(lineIds[0]); top = el.offsetTop; height = el.offsetHeight; parent = el.parentElement.parentElement; if (lineIds.length > 1) { const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]); const bottom = lastEl.offsetTop + lastEl.offsetHeight; height = bottom - top; } if (top !== null && height !== null && parent !== null) { // cook up a div (if necessary) and position it let div = window.document.getElementById("code-annotation-line-highlight"); if (div === null) { div = window.document.createElement("div"); div.setAttribute("id", "code-annotation-line-highlight"); div.style.position = 'absolute'; parent.appendChild(div); } div.style.top = top - 2 + "px"; div.style.height = height + 4 + "px"; div.style.left = 0; let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter"); if (gutterDiv === null) { gutterDiv = window.document.createElement("div"); gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter"); gutterDiv.style.position = 'absolute'; const codeCell = window.document.getElementById(targetCell); const gutter = codeCell.querySelector('.code-annotation-gutter'); gutter.appendChild(gutterDiv); } gutterDiv.style.top = top - 2 + "px"; gutterDiv.style.height = height + 4 + "px"; } selectedAnnoteEl = annoteEl; } }; const unselectCodeLines = () => { const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"]; elementsIds.forEach((elId) => { const div = window.document.getElementById(elId); if (div) { div.remove(); } }); selectedAnnoteEl = undefined; }; // Handle positioning of the toggle window.addEventListener( "resize", throttle(() => { elRect = undefined; if (selectedAnnoteEl) { selectCodeLines(selectedAnnoteEl); } }, 10) ); function throttle(fn, ms) { let throttle = false; let timer; return (...args) => { if(!throttle) { // first call gets through fn.apply(this, args); throttle = true; } else { // all the others get throttled if(timer) clearTimeout(timer); // cancel #2 timer = setTimeout(() => { fn.apply(this, args); timer = throttle = false; }, ms); } }; } // Attach click handler to the DT const annoteDls = window.document.querySelectorAll('dt[data-target-cell]'); for (const annoteDlNode of annoteDls) { annoteDlNode.addEventListener('click', (event) => { const clickedEl = event.target; if (clickedEl !== selectedAnnoteEl) { unselectCodeLines(); const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active'); if (activeEl) { activeEl.classList.remove('code-annotation-active'); } selectCodeLines(clickedEl); clickedEl.classList.add('code-annotation-active'); } else { // Unselect the line unselectCodeLines(); clickedEl.classList.remove('code-annotation-active'); } }); } const findCites = (el) => { const parentEl = el.parentElement; if (parentEl) { const cites = parentEl.dataset.cites; if (cites) { return { el, cites: cites.split(' ') }; } else { return findCites(el.parentElement) } } else { return undefined; } }; var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]'); for (var i=0; i<bibliorefs.length; i++) { const ref = bibliorefs[i]; const citeInfo = findCites(ref); if (citeInfo) { tippyHover(citeInfo.el, function() { var popup = window.document.createElement('div'); citeInfo.cites.forEach(function(cite) { var citeDiv = window.document.createElement('div'); citeDiv.classList.add('hanging-indent'); citeDiv.classList.add('csl-entry'); var biblioDiv = window.document.getElementById('ref-' + cite); if (biblioDiv) { citeDiv.innerHTML = biblioDiv.innerHTML; } popup.appendChild(citeDiv); }); return popup.innerHTML; }); } } }); </script><nav class="page-navigation"><div class="nav-page nav-page-previous"> <a href="./base-R.html" class="pagination-link" aria-label="A field guide to base R"> <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text"><span class="chapter-number">27</span> <span class="chapter-title">A field guide to base R</span></span> </a> </div> <div class="nav-page nav-page-next"> <a href="./quarto.html" class="pagination-link" aria-label="Quarto"> <span class="nav-page-text"><span class="chapter-number">28</span> <span class="chapter-title">Quarto</span></span> <i class="bi bi-arrow-right-short"></i> </a> </div> </nav> </div> <!-- /content --> <footer class="footer"><div class="nav-footer"> <div class="nav-footer-left"> <p>R for Data Science (2e) was written by Hadley Wickham, Mine Çetinkaya-Rundel, and Garrett Grolemund.</p> </div> <div class="nav-footer-center"> <div class="toc-actions"><ul><li><a href="https://github.com/hadley/r4ds/edit/main/communicate.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/hadley/r4ds/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div> <div class="nav-footer-right"> <p>This book was built with <a href="https://quarto.org/">Quarto</a>.</p> </div> </div> </footer> </body></html>