mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
32f93a2be1
* Update roxygen and regenerate. Mostly just whitespace changes and `code` -> `verb`. * R6 documentation for MockShinySession * Install roxygen from GH * % are now auto-escaped (We still need to go find the rest) * Fixed the ramining \% in roxygen Found looking for ^#'.*\\% in all R files, so I believe this is all of them. * Regenerate docs * Decreate indent in roxygen so paragraphs don't get interpreted as code blocks. https://github.com/r-lib/roxygen2/issues/948#issuecomment-546386172 * Namespace * Add MockShinySession reference to pkgdown. * Clean up test warnings * Export session
43 lines
1.5 KiB
R
43 lines
1.5 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/shinywrappers.R
|
|
\name{createRenderFunction}
|
|
\alias{createRenderFunction}
|
|
\title{Implement render functions}
|
|
\usage{
|
|
createRenderFunction(
|
|
func,
|
|
transform = function(value, session, name, ...) value,
|
|
outputFunc = NULL,
|
|
outputArgs = NULL
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{func}{A function without parameters, that returns user data. If the
|
|
returned value is a promise, then the render function will proceed in async
|
|
mode.}
|
|
|
|
\item{transform}{A function that takes four arguments: \code{value},
|
|
\code{session}, \code{name}, and \code{...} (for future-proofing). This
|
|
function will be invoked each time a value is returned from \code{func},
|
|
and is responsible for changing the value into a JSON-ready value to be
|
|
JSON-encoded and sent to the browser.}
|
|
|
|
\item{outputFunc}{The UI function that is used (or most commonly used) with
|
|
this render function. This can be used in R Markdown documents to create
|
|
complete output widgets out of just the render function.}
|
|
|
|
\item{outputArgs}{A list of arguments to pass to the \code{outputFunc}.
|
|
Render functions should include \code{outputArgs = list()} in their own
|
|
parameter list, and pass through the value as this argument, to allow app
|
|
authors to customize outputs. (Currently, this is only supported for
|
|
dynamically generated UIs, such as those created by Shiny code snippets
|
|
embedded in R Markdown documents).}
|
|
}
|
|
\value{
|
|
An annotated render function, ready to be assigned to an
|
|
\code{output} slot.
|
|
}
|
|
\description{
|
|
Implement render functions
|
|
}
|