wip

man/createRenderFunction.Rd

@@ -0,0 +1,39 @@
+% 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
+}
+