File: render_delayed.Rd

package info (click to toggle)
r-cran-rmarkdown 1.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 8,228 kB
  • sloc: sh: 24; makefile: 10
file content (49 lines) | stat: -rw-r--r-- 1,323 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/shiny.R
\name{render_delayed}
\alias{render_delayed}
\title{Delay Rendering for an Expression}
\usage{
render_delayed(expr)
}
\arguments{
\item{expr}{The expression to evaluate.}
}
\value{
An object representing the expression.
}
\description{
In a Shiny document, evaluate the given expression after the document has
finished rendering, instead of during render.
}
\details{
This function is useful inside Shiny documents. It delays the
evaluation of its argument until the document has finished its initial
render, so that the document can be viewed before the calculation is
finished.

Any expression that returns HTML can be wrapped in \code{render_delayed}.
}
\note{
\code{expr} is evaluated in a \strong{copy} of the environment in which
  the \code{render_delayed} call appears. Consequently, no side effects
  created by \code{expr} are visible in succeeding expressions, nor are
  changes to the environment after the call to \code{render_delayed} visible
  to \code{expr}.

  \code{expr} must be an expression that produces HTML.
}
\examples{
\dontrun{
# Add the following code to an R Markdown document

div(Sys.time())

render_delayed({
 Sys.sleep(3)      # simulate an expensive computation
 div(Sys.time())
})

div(Sys.time())
}
}