github/shiny
1
1
Fork 0
mirror of https://github.com/rstudio/shiny.git synced 2026-04-29 03:00:45 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
b0ebb1dd4cedd6664bcceb331326cfed5cd4bca1
shiny/reference/renderPrint.html
cpsievert b0ebb1dd4c Built site for shiny: 1.7.2@1c9f894
2022-06-24 22:57:37 +00:00

227 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!-- 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.0"><title>Text Output — renderPrint • shiny</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"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><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"><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><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- 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"><!-- 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><!-- 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><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Text Output — renderPrint"><meta property="og:description" content="renderPrint() prints the result of expr, while renderText() pastes it
together into a single string. renderPrint() is equivalent to print();
renderText() is equivalent to cat(). Both functions capture all other
printed output generated while evaluating expr.
renderPrint() is usually paired with verbatimTextOutput();
renderText() is usually paired with textOutput()."><meta property="og:image" content="/logo.png"><!-- 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]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">shiny</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.7.2</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://github.com/rstudio/shiny/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Text Output</h1>
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/shinywrappers.R" class="external-link"><code>R/shinywrappers.R</code></a></small>
<div class="hidden name"><code>renderPrint.Rd</code></div>
</div>
<div class="ref-description">
<p><code>renderPrint()</code> prints the result of <code>expr</code>, while <code>renderText()</code> pastes it
together into a single string. <code>renderPrint()</code> is equivalent to <code><a href="https://rdrr.io/r/base/print.html" class="external-link">print()</a></code>;
<code>renderText()</code> is equivalent to <code><a href="https://rdrr.io/r/base/cat.html" class="external-link">cat()</a></code>. Both functions capture all other
printed output generated while evaluating <code>expr</code>.</p>
<p><code>renderPrint()</code> is usually paired with <code><a href="textOutput.html">verbatimTextOutput()</a></code>;
<code>renderText()</code> is usually paired with <code><a href="textOutput.html">textOutput()</a></code>.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">renderPrint</span><span class="op">(</span>
<span class="va">expr</span>,
env <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sys.parent.html" class="external-link">parent.frame</a></span><span class="op">(</span><span class="op">)</span>,
quoted <span class="op">=</span> <span class="cn">FALSE</span>,
width <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"width"</span><span class="op">)</span>,
outputArgs <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>
<span class="op">)</span>
<span class="fu">renderText</span><span class="op">(</span>
<span class="va">expr</span>,
env <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sys.parent.html" class="external-link">parent.frame</a></span><span class="op">(</span><span class="op">)</span>,
quoted <span class="op">=</span> <span class="cn">FALSE</span>,
outputArgs <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>,
sep <span class="op">=</span> <span class="st">" "</span>
<span class="op">)</span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>expr</dt>
<dd><p>An expression to evaluate.</p></dd>
<dt>env</dt>
<dd><p>The parent environment for the reactive expression. By default,
this is the calling environment, the same as when defining an ordinary
non-reactive expression. If <code>expr</code> is a quosure and <code>quoted</code> is <code>TRUE</code>,
then <code>env</code> is ignored.</p></dd>
<dt>quoted</dt>
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>expr</code>
will be used when <code>expr</code> is evaluated. If <code>expr</code> is a quosure and you
would like to use its expression as a value for <code>expr</code>, then you must set
<code>quoted</code> to <code>TRUE</code>.</p></dd>
<dt>width</dt>
<dd><p>Width of printed output.</p></dd>
<dt>outputArgs</dt>
<dd><p>A list of arguments to be passed through to the implicit
call to <code><a href="textOutput.html">verbatimTextOutput()</a></code> or <code><a href="textOutput.html">textOutput()</a></code> when the functions are
used in an interactive RMarkdown document.</p></dd>
<dt>sep</dt>
<dd><p>A separator passed to <code>cat</code> to be appended after each
element.</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>For <code>renderPrint()</code>, note the given expression returns <code>NULL</code> then <code>NULL</code></p>
<p>will actually be visible in the output. To display nothing, make your
function return <code><a href="https://rdrr.io/r/base/invisible.html" class="external-link">invisible()</a></code>.</p>
</div>
<div id="details">
<h2>Details</h2>
<p>The corresponding HTML output tag can be anything (though <code>pre</code> is
recommended if you need a monospace font and whitespace preserved) and should
have the CSS class name <code>shiny-text-output</code>.</p>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span class="fu"><a href="isolate.html">isolate</a></span><span class="op">(</span><span class="op">{</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># renderPrint captures any print output, converts it to a string, and</span></span>
<span class="r-in"><span class="co"># returns it</span></span>
<span class="r-in"><span class="va">visFun</span> <span class="op">&lt;-</span> <span class="fu">renderPrint</span><span class="op">(</span><span class="op">{</span> <span class="st">"foo"</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">visFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># '[1] "foo"'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">invisFun</span> <span class="op">&lt;-</span> <span class="fu">renderPrint</span><span class="op">(</span><span class="op">{</span> <span class="fu"><a href="https://rdrr.io/r/base/invisible.html" class="external-link">invisible</a></span><span class="op">(</span><span class="st">"foo"</span><span class="op">)</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">invisFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># ''</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">multiprintFun</span> <span class="op">&lt;-</span> <span class="fu">renderPrint</span><span class="op">(</span><span class="op">{</span></span>
<span class="r-in"> <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="st">"foo"</span><span class="op">)</span>;</span>
<span class="r-in"> <span class="st">"bar"</span></span>
<span class="r-in"><span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">multiprintFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># '[1] "foo"\n[1] "bar"'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">nullFun</span> <span class="op">&lt;-</span> <span class="fu">renderPrint</span><span class="op">(</span><span class="op">{</span> <span class="cn">NULL</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">nullFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># 'NULL'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">invisNullFun</span> <span class="op">&lt;-</span> <span class="fu">renderPrint</span><span class="op">(</span><span class="op">{</span> <span class="fu"><a href="https://rdrr.io/r/base/invisible.html" class="external-link">invisible</a></span><span class="op">(</span><span class="cn">NULL</span><span class="op">)</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">invisNullFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># ''</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">vecFun</span> <span class="op">&lt;-</span> <span class="fu">renderPrint</span><span class="op">(</span><span class="op">{</span> <span class="fl">1</span><span class="op">:</span><span class="fl">5</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">vecFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># '[1] 1 2 3 4 5'</span></span>
<span class="r-in"></span>
<span class="r-in"></span>
<span class="r-in"><span class="co"># Contrast with renderText, which takes the value returned from the function</span></span>
<span class="r-in"><span class="co"># and uses cat() to convert it to a string</span></span>
<span class="r-in"><span class="va">visFun</span> <span class="op">&lt;-</span> <span class="fu">renderText</span><span class="op">(</span><span class="op">{</span> <span class="st">"foo"</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">visFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># 'foo'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">invisFun</span> <span class="op">&lt;-</span> <span class="fu">renderText</span><span class="op">(</span><span class="op">{</span> <span class="fu"><a href="https://rdrr.io/r/base/invisible.html" class="external-link">invisible</a></span><span class="op">(</span><span class="st">"foo"</span><span class="op">)</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">invisFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># 'foo'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">multiprintFun</span> <span class="op">&lt;-</span> <span class="fu">renderText</span><span class="op">(</span><span class="op">{</span></span>
<span class="r-in"> <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="st">"foo"</span><span class="op">)</span>;</span>
<span class="r-in"> <span class="st">"bar"</span></span>
<span class="r-in"><span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">multiprintFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># 'bar'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">nullFun</span> <span class="op">&lt;-</span> <span class="fu">renderText</span><span class="op">(</span><span class="op">{</span> <span class="cn">NULL</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">nullFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># ''</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">invisNullFun</span> <span class="op">&lt;-</span> <span class="fu">renderText</span><span class="op">(</span><span class="op">{</span> <span class="fu"><a href="https://rdrr.io/r/base/invisible.html" class="external-link">invisible</a></span><span class="op">(</span><span class="cn">NULL</span><span class="op">)</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">invisNullFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># ''</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="va">vecFun</span> <span class="op">&lt;-</span> <span class="fu">renderText</span><span class="op">(</span><span class="op">{</span> <span class="fl">1</span><span class="op">:</span><span class="fl">5</span> <span class="op">}</span><span class="op">)</span></span>
<span class="r-in"><span class="fu">vecFun</span><span class="op">(</span><span class="op">)</span></span>
<span class="r-in"><span class="co"># '1 2 3 4 5'</span></span>
<span class="r-in"></span>
<span class="r-in"><span class="op">}</span><span class="op">)</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "foo"</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "1 2 3 4 5"</span>
</code></pre></div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.5.</p>
</div>
</footer></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink