From df70d7708d09cafe48274540fadc3e053142f9a9 Mon Sep 17 00:00:00 2001 From: trestletech Date: Wed, 19 Jun 2019 14:47:04 -0500 Subject: [PATCH] Result of running roxygen2md(scope = "none") Enables markdown. Only observed one non-whitespace difference on a line that had used backticks previously which were previously not being parsed as a code block. -explicitly using the `title` parameter of the top-level page function. +explicitly using the \code{title} parameter of the top-level page function. --- DESCRIPTION | 1 + man/NS.Rd | 2 +- man/Progress.Rd | 36 +++--- man/bootstrapPage.Rd | 2 +- man/column.Rd | 2 +- man/conditionalPanel.Rd | 8 +- man/createRenderFunction.Rd | 2 +- man/createWebDependency.Rd | 2 +- man/dateInput.Rd | 20 ++-- man/dateRangeInput.Rd | 20 ++-- man/debounce.Rd | 24 ++-- man/diskCache.Rd | 204 ++++++++++++++++---------------- man/enableBookmarking.Rd | 24 ++-- man/exprToFunction.Rd | 4 +- man/fileInput.Rd | 22 ++-- man/fillRow.Rd | 26 ++-- man/fixedPage.Rd | 12 +- man/fluidPage.Rd | 10 +- man/getQueryString.Rd | 4 +- man/icon.Rd | 4 +- man/insertUI.Rd | 12 +- man/installExprFunction.Rd | 2 +- man/isRunning.Rd | 2 +- man/memoryCache.Rd | 196 +++++++++++++++---------------- man/navbarPage.Rd | 10 +- man/navlistPanel.Rd | 10 +- man/observe.Rd | 68 +++++------ man/observeEvent.Rd | 52 ++++---- man/onBookmark.Rd | 34 +++--- man/onFlush.Rd | 2 +- man/onStop.Rd | 2 +- man/outputOptions.Rd | 12 +- man/parseQueryString.Rd | 6 +- man/plotOutput.Rd | 38 +++--- man/reactiveFileReader.Rd | 4 +- man/reactivePoll.Rd | 2 +- man/reactiveTimer.Rd | 6 +- man/reactiveVal.Rd | 2 +- man/registerInputHandler.Rd | 12 +- man/removeInputHandler.Rd | 2 +- man/renderCachedPlot.Rd | 126 ++++++++++---------- man/renderDataTable.Rd | 12 +- man/renderImage.Rd | 2 +- man/renderPlot.Rd | 18 +-- man/renderPrint.Rd | 2 +- man/renderText.Rd | 2 +- man/repeatable.Rd | 4 +- man/req.Rd | 16 +-- man/runApp.Rd | 4 +- man/selectInput.Rd | 14 +-- man/session.Rd | 228 ++++++++++++++++++------------------ man/shiny-options.Rd | 138 +++++++++++----------- man/shinyApp.Rd | 2 +- man/stacktrace.Rd | 68 +++++------ man/tabsetPanel.Rd | 2 +- man/textOutput.Rd | 2 +- man/titlePanel.Rd | 4 +- man/updateQueryString.Rd | 8 +- man/validate.Rd | 16 +-- man/varSelectInput.Rd | 30 ++--- man/verbatimTextOutput.Rd | 4 +- man/viewer.Rd | 2 +- 62 files changed, 804 insertions(+), 803 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3290bfd9a..bb9fa2a71 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -166,3 +166,4 @@ Collate: 'update-input.R' RoxygenNote: 6.1.1 Encoding: UTF-8 +Roxygen: list(markdown = TRUE) diff --git a/man/NS.Rd b/man/NS.Rd index 678a25dff..fff744c3d 100644 --- a/man/NS.Rd +++ b/man/NS.Rd @@ -22,7 +22,7 @@ interpreted as multiple namespaces, in increasing order of specificity } \value{ If \code{id} is missing, returns a function that expects an id string - as its only argument and returns that id with the namespace prepended. +as its only argument and returns that id with the namespace prepended. } \description{ The \code{NS} function creates namespaced IDs out of bare IDs, by joining diff --git a/man/Progress.Rd b/man/Progress.Rd index 4ce0d1113..a2e3682d7 100644 --- a/man/Progress.Rd +++ b/man/Progress.Rd @@ -61,24 +61,24 @@ CSS), you can use \code{style="old"} each time you call function. \strong{Methods} - \describe{ - \item{\code{initialize(session, min = 0, max = 1)}}{ - Creates a new progress panel (but does not display it). - } - \item{\code{set(value = NULL, message = NULL, detail = NULL)}}{ - Updates the progress panel. When called the first time, the - progress panel is displayed. - } - \item{\code{inc(amount = 0.1, message = NULL, detail = NULL)}}{ - Like \code{set}, this updates the progress panel. The difference is - that \code{inc} increases the progress bar by \code{amount}, instead - of setting it to a specific value. - } - \item{\code{close()}}{ - Removes the progress panel. Future calls to \code{set} and - \code{close} will be ignored. - } - } +\describe{ +\item{\code{initialize(session, min = 0, max = 1)}}{ +Creates a new progress panel (but does not display it). +} +\item{\code{set(value = NULL, message = NULL, detail = NULL)}}{ +Updates the progress panel. When called the first time, the +progress panel is displayed. +} +\item{\code{inc(amount = 0.1, message = NULL, detail = NULL)}}{ +Like \code{set}, this updates the progress panel. The difference is +that \code{inc} increases the progress bar by \code{amount}, instead +of setting it to a specific value. +} +\item{\code{close()}}{ +Removes the progress panel. Future calls to \code{set} and +\code{close} will be ignored. +} +} } \examples{ ## Only run examples in interactive R sessions diff --git a/man/bootstrapPage.Rd b/man/bootstrapPage.Rd index b682338cf..c4018c4cb 100644 --- a/man/bootstrapPage.Rd +++ b/man/bootstrapPage.Rd @@ -36,7 +36,7 @@ and know how to lay out pages in Bootstrap. Most applications should use } \note{ The \code{basicPage} function is deprecated, you should use the - \code{\link{fluidPage}} function instead. +\code{\link{fluidPage}} function instead. } \seealso{ \code{\link{fluidPage}}, \code{\link{fixedPage}} diff --git a/man/column.Rd b/man/column.Rd index 47c455267..47a5696d2 100644 --- a/man/column.Rd +++ b/man/column.Rd @@ -16,7 +16,7 @@ previous column.} } \value{ A column that can be included within a - \code{\link{fluidRow}} or \code{\link{fixedRow}}. +\code{\link{fluidRow}} or \code{\link{fixedRow}}. } \description{ Create a column for use within a \code{\link{fluidRow}} or diff --git a/man/conditionalPanel.Rd b/man/conditionalPanel.Rd index 9749aec24..fa615d9ce 100644 --- a/man/conditionalPanel.Rd +++ b/man/conditionalPanel.Rd @@ -29,10 +29,10 @@ objects, as this may cause unpredictable behavior.) } \note{ You are not recommended to use special JavaScript characters such as a - period \code{.} in the input id's, but if you do use them anyway, for - example, \code{inputId = "foo.bar"}, you will have to use - \code{input["foo.bar"]} instead of \code{input.foo.bar} to read the input - value. +period \code{.} in the input id's, but if you do use them anyway, for +example, \code{inputId = "foo.bar"}, you will have to use +\code{input["foo.bar"]} instead of \code{input.foo.bar} to read the input +value. } \examples{ ## Only run this example in interactive R sessions diff --git a/man/createRenderFunction.Rd b/man/createRenderFunction.Rd index 31154247c..b7b5ac16a 100644 --- a/man/createRenderFunction.Rd +++ b/man/createRenderFunction.Rd @@ -31,7 +31,7 @@ embedded in R Markdown documents).} } \value{ An annotated render function, ready to be assigned to an - \code{output} slot. +\code{output} slot. } \description{ Implement render functions diff --git a/man/createWebDependency.Rd b/man/createWebDependency.Rd index 12c7fa574..ccfeec250 100644 --- a/man/createWebDependency.Rd +++ b/man/createWebDependency.Rd @@ -19,7 +19,7 @@ cases.} } \value{ A single HTML dependency object that has an \code{href}-named element - in its \code{src}. +in its \code{src}. } \description{ Ensure that a file-based HTML dependency (from the htmltools package) can be diff --git a/man/dateInput.Rd b/man/dateInput.Rd index 4d8c1bb1b..77185f9f4 100644 --- a/man/dateInput.Rd +++ b/man/dateInput.Rd @@ -63,16 +63,16 @@ The date \code{format} string specifies how the date will be displayed in the browser. It allows the following values: \itemize{ - \item \code{yy} Year without century (12) - \item \code{yyyy} Year with century (2012) - \item \code{mm} Month number, with leading zero (01-12) - \item \code{m} Month number, without leading zero (1-12) - \item \code{M} Abbreviated month name - \item \code{MM} Full month name - \item \code{dd} Day of month with leading zero - \item \code{d} Day of month without leading zero - \item \code{D} Abbreviated weekday name - \item \code{DD} Full weekday name +\item \code{yy} Year without century (12) +\item \code{yyyy} Year with century (2012) +\item \code{mm} Month number, with leading zero (01-12) +\item \code{m} Month number, without leading zero (1-12) +\item \code{M} Abbreviated month name +\item \code{MM} Full month name +\item \code{dd} Day of month with leading zero +\item \code{d} Day of month without leading zero +\item \code{D} Abbreviated weekday name +\item \code{DD} Full weekday name } } \examples{ diff --git a/man/dateRangeInput.Rd b/man/dateRangeInput.Rd index 1d1b2c24f..466c7aa19 100644 --- a/man/dateRangeInput.Rd +++ b/man/dateRangeInput.Rd @@ -63,16 +63,16 @@ The date \code{format} string specifies how the date will be displayed in the browser. It allows the following values: \itemize{ - \item \code{yy} Year without century (12) - \item \code{yyyy} Year with century (2012) - \item \code{mm} Month number, with leading zero (01-12) - \item \code{m} Month number, without leading zero (1-12) - \item \code{M} Abbreviated month name - \item \code{MM} Full month name - \item \code{dd} Day of month with leading zero - \item \code{d} Day of month without leading zero - \item \code{D} Abbreviated weekday name - \item \code{DD} Full weekday name +\item \code{yy} Year without century (12) +\item \code{yyyy} Year with century (2012) +\item \code{mm} Month number, with leading zero (01-12) +\item \code{m} Month number, without leading zero (1-12) +\item \code{M} Abbreviated month name +\item \code{MM} Full month name +\item \code{dd} Day of month with leading zero +\item \code{d} Day of month without leading zero +\item \code{D} Abbreviated weekday name +\item \code{DD} Full weekday name } } \examples{ diff --git a/man/debounce.Rd b/man/debounce.Rd index bdef32b9e..3e75d5166 100644 --- a/man/debounce.Rd +++ b/man/debounce.Rd @@ -66,19 +66,19 @@ window. \section{Limitations}{ - Because R is single threaded, we can't come close to guaranteeing that the - timing of debounce/throttle (or any other timing-related functions in - Shiny) will be consistent or accurate; at the time we want to emit an - invalidation signal, R may be performing a different task and we have no - way to interrupt it (nor would we necessarily want to if we could). - Therefore, it's best to think of the time windows you pass to these - functions as minimums. +Because R is single threaded, we can't come close to guaranteeing that the +timing of debounce/throttle (or any other timing-related functions in +Shiny) will be consistent or accurate; at the time we want to emit an +invalidation signal, R may be performing a different task and we have no +way to interrupt it (nor would we necessarily want to if we could). +Therefore, it's best to think of the time windows you pass to these +functions as minimums. - You may also see undesirable behavior if the amount of time spent doing - downstream processing for each change approaches or exceeds the time - window: in this case, debounce/throttle may not have any effect, as the - time each subsequent event is considered is already after the time window - has expired. +You may also see undesirable behavior if the amount of time spent doing +downstream processing for each change approaches or exceeds the time +window: in this case, debounce/throttle may not have any effect, as the +time each subsequent event is considered is already after the time window +has expired. } \examples{ diff --git a/man/diskCache.Rd b/man/diskCache.Rd index 08edfbbe9..ef9e6988a 100644 --- a/man/diskCache.Rd +++ b/man/diskCache.Rd @@ -59,39 +59,39 @@ and \code{evict}. \section{Missing Keys}{ - The \code{missing} and \code{exec_missing} parameters controls what happens - when \code{get()} is called with a key that is not in the cache (a cache - miss). The default behavior is to return a \code{\link{key_missing}} - object. This is a \emph{sentinel value} that indicates that the key was not - present in the cache. You can test if the returned value represents a - missing key by using the \code{\link{is.key_missing}} function. You can - also have \code{get()} return a different sentinel value, like \code{NULL}. - If you want to throw an error on a cache miss, you can do so by providing a - function for \code{missing} that takes one argument, the key, and also use - \code{exec_missing=TRUE}. +The \code{missing} and \code{exec_missing} parameters controls what happens +when \code{get()} is called with a key that is not in the cache (a cache +miss). The default behavior is to return a \code{\link{key_missing}} +object. This is a \emph{sentinel value} that indicates that the key was not +present in the cache. You can test if the returned value represents a +missing key by using the \code{\link{is.key_missing}} function. You can +also have \code{get()} return a different sentinel value, like \code{NULL}. +If you want to throw an error on a cache miss, you can do so by providing a +function for \code{missing} that takes one argument, the key, and also use +\code{exec_missing=TRUE}. - When the cache is created, you can supply a value for \code{missing}, which - sets the default value to be returned for missing values. It can also be - overridden when \code{get()} is called, by supplying a \code{missing} - argument. For example, if you use \code{cache$get("mykey", missing = +When the cache is created, you can supply a value for \code{missing}, which +sets the default value to be returned for missing values. It can also be +overridden when \code{get()} is called, by supplying a \code{missing} +argument. For example, if you use \code{cache$get("mykey", missing = NULL)}, it will return \code{NULL} if the key is not in the cache. - If your cache is configured so that \code{get()} returns a sentinel value - to represent a cache miss, then \code{set} will also not allow you to store - the sentinel value in the cache. It will throw an error if you attempt to - do so. +If your cache is configured so that \code{get()} returns a sentinel value +to represent a cache miss, then \code{set} will also not allow you to store +the sentinel value in the cache. It will throw an error if you attempt to +do so. - Instead of returning the same sentinel value each time there is cache miss, - the cache can execute a function each time \code{get()} encounters missing - key. If the function returns a value, then \code{get()} will in turn return - that value. However, a more common use is for the function to throw an - error. If an error is thrown, then \code{get()} will not return a value. +Instead of returning the same sentinel value each time there is cache miss, +the cache can execute a function each time \code{get()} encounters missing +key. If the function returns a value, then \code{get()} will in turn return +that value. However, a more common use is for the function to throw an +error. If an error is thrown, then \code{get()} will not return a value. - To do this, pass a one-argument function to \code{missing}, and use - \code{exec_missing=TRUE}. For example, if you want to throw an error that - prints the missing key, you could do this: +To do this, pass a one-argument function to \code{missing}, and use +\code{exec_missing=TRUE}. For example, if you want to throw an error that +prints the missing key, you could do this: - \preformatted{ +\preformatted{ diskCache( missing = function(key) { stop("Attempted to get missing key: ", key) @@ -100,46 +100,46 @@ and \code{evict}. ) } - If you use this, the code that calls \code{get()} should be wrapped with - \code{\link{tryCatch}()} to gracefully handle missing keys. +If you use this, the code that calls \code{get()} should be wrapped with +\code{\link{tryCatch}()} to gracefully handle missing keys. } \section{Cache pruning}{ - Cache pruning occurs when \code{set()} is called, or it can be invoked - manually by calling \code{prune()}. +Cache pruning occurs when \code{set()} is called, or it can be invoked +manually by calling \code{prune()}. - The disk cache will throttle the pruning so that it does not happen on - every call to \code{set()}, because the filesystem operations for checking - the status of files can be slow. Instead, it will prune once in every 20 - calls to \code{set()}, or if at least 5 seconds have elapsed since the last - prune occurred, whichever is first. These parameters are currently not - customizable, but may be in the future. +The disk cache will throttle the pruning so that it does not happen on +every call to \code{set()}, because the filesystem operations for checking +the status of files can be slow. Instead, it will prune once in every 20 +calls to \code{set()}, or if at least 5 seconds have elapsed since the last +prune occurred, whichever is first. These parameters are currently not +customizable, but may be in the future. - When a pruning occurs, if there are any objects that are older than - \code{max_age}, they will be removed. +When a pruning occurs, if there are any objects that are older than +\code{max_age}, they will be removed. - The \code{max_size} and \code{max_n} parameters are applied to the cache as - a whole, in contrast to \code{max_age}, which is applied to each object - individually. +The \code{max_size} and \code{max_n} parameters are applied to the cache as +a whole, in contrast to \code{max_age}, which is applied to each object +individually. - If the number of objects in the cache exceeds \code{max_n}, then objects - will be removed from the cache according to the eviction policy, which is - set with the \code{evict} parameter. Objects will be removed so that the - number of items is \code{max_n}. +If the number of objects in the cache exceeds \code{max_n}, then objects +will be removed from the cache according to the eviction policy, which is +set with the \code{evict} parameter. Objects will be removed so that the +number of items is \code{max_n}. - If the size of the objects in the cache exceeds \code{max_size}, then - objects will be removed from the cache. Objects will be removed from the - cache so that the total size remains under \code{max_size}. Note that the - size is calculated using the size of the files, not the size of disk space - used by the files -- these two values can differ because of files are - stored in blocks on disk. For example, if the block size is 4096 bytes, - then a file that is one byte in size will take 4096 bytes on disk. +If the size of the objects in the cache exceeds \code{max_size}, then +objects will be removed from the cache. Objects will be removed from the +cache so that the total size remains under \code{max_size}. Note that the +size is calculated using the size of the files, not the size of disk space +used by the files -- these two values can differ because of files are +stored in blocks on disk. For example, if the block size is 4096 bytes, +then a file that is one byte in size will take 4096 bytes on disk. - Another time that objects can be removed from the cache is when - \code{get()} is called. If the target object is older than \code{max_age}, - it will be removed and the cache will report it as a missing value. +Another time that objects can be removed from the cache is when +\code{get()} is called. If the target object is older than \code{max_age}, +it will be removed and the cache will report it as a missing value. } \section{Eviction policies}{ @@ -149,16 +149,16 @@ If \code{max_n} or \code{max_size} are used, then objects will be removed from the cache according to an eviction policy. The available eviction policies are: - \describe{ - \item{\code{"lru"}}{ - Least Recently Used. The least recently used objects will be removed. - This uses the filesystem's mtime property. When "lru" is used, each - \code{get()} is called, it will update the file's mtime. - } - \item{\code{"fifo"}}{ - First-in-first-out. The oldest objects will be removed. - } - } +\describe{ +\item{\code{"lru"}}{ +Least Recently Used. The least recently used objects will be removed. +This uses the filesystem's mtime property. When "lru" is used, each +\code{get()} is called, it will update the file's mtime. +} +\item{\code{"fifo"}}{ +First-in-first-out. The oldest objects will be removed. +} +} Both of these policies use files' mtime. Note that some filesystems (notably FAT) have poor mtime resolution. (atime is not used because support for @@ -198,42 +198,42 @@ already been deleted. \section{Methods}{ - A disk cache object has the following methods: +A disk cache object has the following methods: - \describe{ - \item{\code{get(key, missing, exec_missing)}}{ - Returns the value associated with \code{key}. If the key is not in the - cache, then it returns the value specified by \code{missing} or, - \code{missing} is a function and \code{exec_missing=TRUE}, then - executes \code{missing}. The function can throw an error or return the - value. If either of these parameters are specified here, then they - will override the defaults that were set when the DiskCache object was - created. See section Missing Keys for more information. - } - \item{\code{set(key, value)}}{ - Stores the \code{key}-\code{value} pair in the cache. - } - \item{\code{exists(key)}}{ - Returns \code{TRUE} if the cache contains the key, otherwise - \code{FALSE}. - } - \item{\code{size()}}{ - Returns the number of items currently in the cache. - } - \item{\code{keys()}}{ - Returns a character vector of all keys currently in the cache. - } - \item{\code{reset()}}{ - Clears all objects from the cache. - } - \item{\code{destroy()}}{ - Clears all objects in the cache, and removes the cache directory from - disk. - } - \item{\code{prune()}}{ - Prunes the cache, using the parameters specified by \code{max_size}, - \code{max_age}, \code{max_n}, and \code{evict}. - } - } +\describe{ +\item{\code{get(key, missing, exec_missing)}}{ +Returns the value associated with \code{key}. If the key is not in the +cache, then it returns the value specified by \code{missing} or, +\code{missing} is a function and \code{exec_missing=TRUE}, then +executes \code{missing}. The function can throw an error or return the +value. If either of these parameters are specified here, then they +will override the defaults that were set when the DiskCache object was +created. See section Missing Keys for more information. +} +\item{\code{set(key, value)}}{ +Stores the \code{key}-\code{value} pair in the cache. +} +\item{\code{exists(key)}}{ +Returns \code{TRUE} if the cache contains the key, otherwise +\code{FALSE}. +} +\item{\code{size()}}{ +Returns the number of items currently in the cache. +} +\item{\code{keys()}}{ +Returns a character vector of all keys currently in the cache. +} +\item{\code{reset()}}{ +Clears all objects from the cache. +} +\item{\code{destroy()}}{ +Clears all objects in the cache, and removes the cache directory from +disk. +} +\item{\code{prune()}}{ +Prunes the cache, using the parameters specified by \code{max_size}, +\code{max_age}, \code{max_n}, and \code{evict}. +} +} } diff --git a/man/enableBookmarking.Rd b/man/enableBookmarking.Rd index 1b804e1b9..88d3b4205 100644 --- a/man/enableBookmarking.Rd +++ b/man/enableBookmarking.Rd @@ -46,14 +46,14 @@ can be used to save extra information to files in that directory. For saved-to-server state, this is how the state directory is chosen: \itemize{ - \item If running in a hosting environment such as Shiny Server or - Connect, the hosting environment will choose the directory. - \item If running an app in a directory with \code{\link{runApp}()}, the - saved states will be saved in a subdirectory of the app called - shiny_bookmarks. - \item If running a Shiny app object that is generated from code (not run - from a directory), the saved states will be saved in a subdirectory of - the current working directory called shiny_bookmarks. +\item If running in a hosting environment such as Shiny Server or +Connect, the hosting environment will choose the directory. +\item If running an app in a directory with \code{\link{runApp}()}, the +saved states will be saved in a subdirectory of the app called +shiny_bookmarks. +\item If running a Shiny app object that is generated from code (not run +from a directory), the saved states will be saved in a subdirectory of +the current working directory called shiny_bookmarks. } When used with \code{\link{shinyApp}()}, this function must be called before @@ -222,9 +222,9 @@ shinyApp(ui, server) } \seealso{ \code{\link{onBookmark}}, \code{\link{onBookmarked}}, - \code{\link{onRestore}}, and \code{\link{onRestored}} for registering - callback functions that are invoked when the state is bookmarked or - restored. +\code{\link{onRestore}}, and \code{\link{onRestored}} for registering +callback functions that are invoked when the state is bookmarked or +restored. - Also see \code{\link{updateQueryString}}. +Also see \code{\link{updateQueryString}}. } diff --git a/man/exprToFunction.Rd b/man/exprToFunction.Rd index 2e12f1ea9..4e12e4014 100644 --- a/man/exprToFunction.Rd +++ b/man/exprToFunction.Rd @@ -21,9 +21,9 @@ an unquoted expression from two calls back. \details{ If expr is a quoted expression, then this just converts it to a function. If expr is a function, then this simply returns expr (and prints a - deprecation message). +deprecation message). If expr was a non-quoted expression from two calls back, then this will - quote the original expression and convert it to a function. +quote the original expression and convert it to a function. } \examples{ # Example of a new renderer, similar to renderText diff --git a/man/fileInput.Rd b/man/fileInput.Rd index 0c5f58d0e..38c89ae80 100644 --- a/man/fileInput.Rd +++ b/man/fileInput.Rd @@ -36,17 +36,17 @@ Whenever a file upload completes, the corresponding input variable is set to a dataframe. This dataframe contains one row for each selected file, and the following columns: \describe{ - \item{\code{name}}{The filename provided by the web browser. This is - \strong{not} the path to read to get at the actual data that was uploaded - (see - \code{datapath} column).} - \item{\code{size}}{The size of the uploaded data, in - bytes.} - \item{\code{type}}{The MIME type reported by the browser (for example, - \code{text/plain}), or empty string if the browser didn't know.} - \item{\code{datapath}}{The path to a temp file that contains the data that was - uploaded. This file may be deleted if the user performs another upload - operation.} +\item{\code{name}}{The filename provided by the web browser. This is +\strong{not} the path to read to get at the actual data that was uploaded +(see +\code{datapath} column).} +\item{\code{size}}{The size of the uploaded data, in +bytes.} +\item{\code{type}}{The MIME type reported by the browser (for example, +\code{text/plain}), or empty string if the browser didn't know.} +\item{\code{datapath}}{The path to a temp file that contains the data that was +uploaded. This file may be deleted if the user performs another upload +operation.} } } \examples{ diff --git a/man/fillRow.Rd b/man/fillRow.Rd index e3cfab155..8c37f0cbc 100644 --- a/man/fillRow.Rd +++ b/man/fillRow.Rd @@ -38,20 +38,20 @@ browsers can be assumed. } \details{ If you try to use \code{fillRow} and \code{fillCol} inside of other - Shiny containers, such as \code{\link{sidebarLayout}}, - \code{\link{navbarPage}}, or even \code{tags$div}, you will probably find - that they will not appear. This is due to \code{fillRow} and \code{fillCol} - defaulting to \code{height="100\%"}, which will only work inside of - containers that have determined their own size (rather than shrinking to - the size of their contents, as is usually the case in HTML). +Shiny containers, such as \code{\link{sidebarLayout}}, +\code{\link{navbarPage}}, or even \code{tags$div}, you will probably find +that they will not appear. This is due to \code{fillRow} and \code{fillCol} +defaulting to \code{height="100\%"}, which will only work inside of +containers that have determined their own size (rather than shrinking to +the size of their contents, as is usually the case in HTML). - To avoid this problem, you have two options: - \itemize{ - \item only use \code{fillRow}/\code{fillCol} inside of \code{fillPage}, - \code{fillRow}, or \code{fillCol} - \item provide an explicit \code{height} argument to - \code{fillRow}/\code{fillCol} - } +To avoid this problem, you have two options: +\itemize{ +\item only use \code{fillRow}/\code{fillCol} inside of \code{fillPage}, +\code{fillRow}, or \code{fillCol} +\item provide an explicit \code{height} argument to +\code{fillRow}/\code{fillCol} +} } \examples{ # Only run this example in interactive R sessions. diff --git a/man/fixedPage.Rd b/man/fixedPage.Rd index 6f4446a12..100ab6573 100644 --- a/man/fixedPage.Rd +++ b/man/fixedPage.Rd @@ -35,15 +35,15 @@ displays respectively. } \details{ To create a fixed page use the \code{fixedPage} function and include - instances of \code{fixedRow} and \code{\link{column}} within it. Note that - unlike \code{\link{fluidPage}}, fixed pages cannot make use of higher-level - layout functions like \code{sidebarLayout}, rather, all layout must be done - with \code{fixedRow} and \code{column}. +instances of \code{fixedRow} and \code{\link{column}} within it. Note that +unlike \code{\link{fluidPage}}, fixed pages cannot make use of higher-level +layout functions like \code{sidebarLayout}, rather, all layout must be done +with \code{fixedRow} and \code{column}. } \note{ See the \href{http://shiny.rstudio.com/articles/layout-guide.html}{ - Shiny Application Layout Guide} for additional details on laying out fixed - pages. +Shiny Application Layout Guide} for additional details on laying out fixed +pages. } \examples{ ## Only run examples in interactive R sessions diff --git a/man/fluidPage.Rd b/man/fluidPage.Rd index b1798911c..f9918ca80 100644 --- a/man/fluidPage.Rd +++ b/man/fluidPage.Rd @@ -35,14 +35,14 @@ components in realtime to fill all available browser width. } \details{ To create a fluid page use the \code{fluidPage} function and include - instances of \code{fluidRow} and \code{\link{column}} within it. As an - alternative to low-level row and column functions you can also use - higher-level layout functions like \code{\link{sidebarLayout}}. +instances of \code{fluidRow} and \code{\link{column}} within it. As an +alternative to low-level row and column functions you can also use +higher-level layout functions like \code{\link{sidebarLayout}}. } \note{ See the \href{http://shiny.rstudio.com/articles/layout-guide.html}{ - Shiny-Application-Layout-Guide} for additional details on laying out fluid - pages. +Shiny-Application-Layout-Guide} for additional details on laying out fluid +pages. } \examples{ ## Only run examples in interactive R sessions diff --git a/man/getQueryString.Rd b/man/getQueryString.Rd index 2fba74e1d..eb2b97e6a 100644 --- a/man/getQueryString.Rd +++ b/man/getQueryString.Rd @@ -14,9 +14,9 @@ getUrlHash(session = getDefaultReactiveDomain()) } \value{ For \code{getQueryString}, a named list. For example, the query - string \code{?param1=value1¶m2=value2} becomes \code{list(param1 = +string \code{?param1=value1¶m2=value2} becomes \code{list(param1 = value1, param2 = value2)}. For \code{getUrlHash}, a character vector with - the hash (including the leading \code{#} symbol). +the hash (including the leading \code{#} symbol). } \description{ Two user friendly wrappers for getting the query string and the hash diff --git a/man/icon.Rd b/man/icon.Rd index 60402f394..440e08cf3 100644 --- a/man/icon.Rd +++ b/man/icon.Rd @@ -41,6 +41,6 @@ navbarPage("App Title", } \seealso{ For lists of available icons, see - \href{http://fontawesome.io/icons/}{http://fontawesome.io/icons/} and - \href{http://getbootstrap.com/components/#glyphicons}{http://getbootstrap.com/components/#glyphicons}. +\href{http://fontawesome.io/icons/}{http://fontawesome.io/icons/} and +\href{http://getbootstrap.com/components/#glyphicons}{http://getbootstrap.com/components/#glyphicons}. } diff --git a/man/insertUI.Rd b/man/insertUI.Rd index 97f284ac0..6c0476b4a 100644 --- a/man/insertUI.Rd +++ b/man/insertUI.Rd @@ -16,12 +16,12 @@ UI object.} \item{where}{Where your UI object should go relative to the selector: \describe{ - \item{\code{beforeBegin}}{Before the selector element itself} - \item{\code{afterBegin}}{Just inside the selector element, before its - first child} - \item{\code{beforeEnd}}{Just inside the selector element, after its - last child (default)} - \item{\code{afterEnd}}{After the selector element itself} +\item{\code{beforeBegin}}{Before the selector element itself} +\item{\code{afterBegin}}{Just inside the selector element, before its +first child} +\item{\code{beforeEnd}}{Just inside the selector element, after its +last child (default)} +\item{\code{afterEnd}}{After the selector element itself} } Adapted from \href{https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentHTML}{here}.} diff --git a/man/installExprFunction.Rd b/man/installExprFunction.Rd index 0d06a7944..ef373cd87 100644 --- a/man/installExprFunction.Rd +++ b/man/installExprFunction.Rd @@ -39,5 +39,5 @@ function named \code{func} in the current environment. } \seealso{ Wraps \code{\link{exprToFunction}}; see that method's documentation - for more documentation and examples. +for more documentation and examples. } diff --git a/man/isRunning.Rd b/man/isRunning.Rd index a17e0b6d2..a661e167c 100644 --- a/man/isRunning.Rd +++ b/man/isRunning.Rd @@ -8,7 +8,7 @@ isRunning() } \value{ \code{TRUE} if a Shiny application is currently running. Otherwise, - \code{FALSE}. +\code{FALSE}. } \description{ This function tests whether a Shiny application is currently running. diff --git a/man/memoryCache.Rd b/man/memoryCache.Rd index d36a659a3..be632e69f 100644 --- a/man/memoryCache.Rd +++ b/man/memoryCache.Rd @@ -58,39 +58,39 @@ MemoryCache, it will not be garbage collected. } \section{Missing keys}{ - The \code{missing} and \code{exec_missing} parameters controls what happens - when \code{get()} is called with a key that is not in the cache (a cache - miss). The default behavior is to return a \code{\link{key_missing}} - object. This is a \emph{sentinel value} that indicates that the key was not - present in the cache. You can test if the returned value represents a - missing key by using the \code{\link{is.key_missing}} function. You can - also have \code{get()} return a different sentinel value, like \code{NULL}. - If you want to throw an error on a cache miss, you can do so by providing a - function for \code{missing} that takes one argument, the key, and also use - \code{exec_missing=TRUE}. +The \code{missing} and \code{exec_missing} parameters controls what happens +when \code{get()} is called with a key that is not in the cache (a cache +miss). The default behavior is to return a \code{\link{key_missing}} +object. This is a \emph{sentinel value} that indicates that the key was not +present in the cache. You can test if the returned value represents a +missing key by using the \code{\link{is.key_missing}} function. You can +also have \code{get()} return a different sentinel value, like \code{NULL}. +If you want to throw an error on a cache miss, you can do so by providing a +function for \code{missing} that takes one argument, the key, and also use +\code{exec_missing=TRUE}. - When the cache is created, you can supply a value for \code{missing}, which - sets the default value to be returned for missing values. It can also be - overridden when \code{get()} is called, by supplying a \code{missing} - argument. For example, if you use \code{cache$get("mykey", missing = +When the cache is created, you can supply a value for \code{missing}, which +sets the default value to be returned for missing values. It can also be +overridden when \code{get()} is called, by supplying a \code{missing} +argument. For example, if you use \code{cache$get("mykey", missing = NULL)}, it will return \code{NULL} if the key is not in the cache. - If your cache is configured so that \code{get()} returns a sentinel value - to represent a cache miss, then \code{set} will also not allow you to store - the sentinel value in the cache. It will throw an error if you attempt to - do so. +If your cache is configured so that \code{get()} returns a sentinel value +to represent a cache miss, then \code{set} will also not allow you to store +the sentinel value in the cache. It will throw an error if you attempt to +do so. - Instead of returning the same sentinel value each time there is cache miss, - the cache can execute a function each time \code{get()} encounters missing - key. If the function returns a value, then \code{get()} will in turn return - that value. However, a more common use is for the function to throw an - error. If an error is thrown, then \code{get()} will not return a value. +Instead of returning the same sentinel value each time there is cache miss, +the cache can execute a function each time \code{get()} encounters missing +key. If the function returns a value, then \code{get()} will in turn return +that value. However, a more common use is for the function to throw an +error. If an error is thrown, then \code{get()} will not return a value. - To do this, pass a one-argument function to \code{missing}, and use - \code{exec_missing=TRUE}. For example, if you want to throw an error that - prints the missing key, you could do this: +To do this, pass a one-argument function to \code{missing}, and use +\code{exec_missing=TRUE}. For example, if you want to throw an error that +prints the missing key, you could do this: - \preformatted{ +\preformatted{ diskCache( missing = function(key) { stop("Attempted to get missing key: ", key) @@ -99,39 +99,39 @@ MemoryCache, it will not be garbage collected. ) } - If you use this, the code that calls \code{get()} should be wrapped with - \code{\link{tryCatch}()} to gracefully handle missing keys. +If you use this, the code that calls \code{get()} should be wrapped with +\code{\link{tryCatch}()} to gracefully handle missing keys. } \section{Cache pruning}{ - Cache pruning occurs when \code{set()} is called, or it can be invoked - manually by calling \code{prune()}. +Cache pruning occurs when \code{set()} is called, or it can be invoked +manually by calling \code{prune()}. - When a pruning occurs, if there are any objects that are older than - \code{max_age}, they will be removed. +When a pruning occurs, if there are any objects that are older than +\code{max_age}, they will be removed. - The \code{max_size} and \code{max_n} parameters are applied to the cache as - a whole, in contrast to \code{max_age}, which is applied to each object - individually. +The \code{max_size} and \code{max_n} parameters are applied to the cache as +a whole, in contrast to \code{max_age}, which is applied to each object +individually. - If the number of objects in the cache exceeds \code{max_n}, then objects - will be removed from the cache according to the eviction policy, which is - set with the \code{evict} parameter. Objects will be removed so that the - number of items is \code{max_n}. +If the number of objects in the cache exceeds \code{max_n}, then objects +will be removed from the cache according to the eviction policy, which is +set with the \code{evict} parameter. Objects will be removed so that the +number of items is \code{max_n}. - If the size of the objects in the cache exceeds \code{max_size}, then - objects will be removed from the cache. Objects will be removed from the - cache so that the total size remains under \code{max_size}. Note that the - size is calculated using the size of the files, not the size of disk space - used by the files -- these two values can differ because of files are - stored in blocks on disk. For example, if the block size is 4096 bytes, - then a file that is one byte in size will take 4096 bytes on disk. +If the size of the objects in the cache exceeds \code{max_size}, then +objects will be removed from the cache. Objects will be removed from the +cache so that the total size remains under \code{max_size}. Note that the +size is calculated using the size of the files, not the size of disk space +used by the files -- these two values can differ because of files are +stored in blocks on disk. For example, if the block size is 4096 bytes, +then a file that is one byte in size will take 4096 bytes on disk. - Another time that objects can be removed from the cache is when - \code{get()} is called. If the target object is older than \code{max_age}, - it will be removed and the cache will report it as a missing value. +Another time that objects can be removed from the cache is when +\code{get()} is called. If the target object is older than \code{max_age}, +it will be removed and the cache will report it as a missing value. } \section{Eviction policies}{ @@ -141,59 +141,59 @@ If \code{max_n} or \code{max_size} are used, then objects will be removed from the cache according to an eviction policy. The available eviction policies are: - \describe{ - \item{\code{"lru"}}{ - Least Recently Used. The least recently used objects will be removed. - This uses the filesystem's atime property. Some filesystems do not - support atime, or have a very low atime resolution. The DiskCache will - check for atime support, and if the filesystem does not support atime, - a warning will be issued and the "fifo" policy will be used instead. - } - \item{\code{"fifo"}}{ - First-in-first-out. The oldest objects will be removed. - } - } +\describe{ +\item{\code{"lru"}}{ +Least Recently Used. The least recently used objects will be removed. +This uses the filesystem's atime property. Some filesystems do not +support atime, or have a very low atime resolution. The DiskCache will +check for atime support, and if the filesystem does not support atime, +a warning will be issued and the "fifo" policy will be used instead. +} +\item{\code{"fifo"}}{ +First-in-first-out. The oldest objects will be removed. +} +} } \section{Methods}{ - A disk cache object has the following methods: +A disk cache object has the following methods: - \describe{ - \item{\code{get(key, missing, exec_missing)}}{ - Returns the value associated with \code{key}. If the key is not in the - cache, then it returns the value specified by \code{missing} or, - \code{missing} is a function and \code{exec_missing=TRUE}, then - executes \code{missing}. The function can throw an error or return the - value. If either of these parameters are specified here, then they - will override the defaults that were set when the DiskCache object was - created. See section Missing Keys for more information. - } - \item{\code{set(key, value)}}{ - Stores the \code{key}-\code{value} pair in the cache. - } - \item{\code{exists(key)}}{ - Returns \code{TRUE} if the cache contains the key, otherwise - \code{FALSE}. - } - \item{\code{size()}}{ - Returns the number of items currently in the cache. - } - \item{\code{keys()}}{ - Returns a character vector of all keys currently in the cache. - } - \item{\code{reset()}}{ - Clears all objects from the cache. - } - \item{\code{destroy()}}{ - Clears all objects in the cache, and removes the cache directory from - disk. - } - \item{\code{prune()}}{ - Prunes the cache, using the parameters specified by \code{max_size}, - \code{max_age}, \code{max_n}, and \code{evict}. - } - } +\describe{ +\item{\code{get(key, missing, exec_missing)}}{ +Returns the value associated with \code{key}. If the key is not in the +cache, then it returns the value specified by \code{missing} or, +\code{missing} is a function and \code{exec_missing=TRUE}, then +executes \code{missing}. The function can throw an error or return the +value. If either of these parameters are specified here, then they +will override the defaults that were set when the DiskCache object was +created. See section Missing Keys for more information. +} +\item{\code{set(key, value)}}{ +Stores the \code{key}-\code{value} pair in the cache. +} +\item{\code{exists(key)}}{ +Returns \code{TRUE} if the cache contains the key, otherwise +\code{FALSE}. +} +\item{\code{size()}}{ +Returns the number of items currently in the cache. +} +\item{\code{keys()}}{ +Returns a character vector of all keys currently in the cache. +} +\item{\code{reset()}}{ +Clears all objects from the cache. +} +\item{\code{destroy()}}{ +Clears all objects in the cache, and removes the cache directory from +disk. +} +\item{\code{prune()}}{ +Prunes the cache, using the parameters specified by \code{max_size}, +\code{max_age}, \code{max_n}, and \code{evict}. +} +} } diff --git a/man/navbarPage.Rd b/man/navbarPage.Rd index 42f5df92b..8605ffba5 100644 --- a/man/navbarPage.Rd +++ b/man/navbarPage.Rd @@ -36,7 +36,7 @@ the top (\code{"fixed-top"}), or pinned at the bottom (\code{"fixed-bottom"}). Note that using \code{"fixed-top"} or \code{"fixed-bottom"} will cause the navbar to overlay your body content, unless you add padding, e.g.: \code{tags$style(type="text/css", "body -{padding-top: 70px;}")}} + {padding-top: 70px;}")}} \item{header}{Tag or list of tags to display as a common header above all tabPanels.} @@ -81,8 +81,8 @@ toggle a set of \code{\link{tabPanel}} elements. } \details{ The \code{navbarMenu} function can be used to create an embedded - menu within the navbar that in turns includes additional tabPanels (see - example below). +menu within the navbar that in turns includes additional tabPanels (see +example below). } \examples{ navbarPage("App Title", @@ -103,6 +103,6 @@ navbarPage("App Title", } \seealso{ \code{\link{tabPanel}}, \code{\link{tabsetPanel}}, - \code{\link{updateNavbarPage}}, \code{\link{insertTab}}, - \code{\link{showTab}} +\code{\link{updateNavbarPage}}, \code{\link{insertTab}}, +\code{\link{showTab}} } diff --git a/man/navlistPanel.Rd b/man/navlistPanel.Rd index d9fc8047a..4b5b57366 100644 --- a/man/navlistPanel.Rd +++ b/man/navlistPanel.Rd @@ -34,10 +34,10 @@ which navigate to a set of tabPanels displayed to the right. } \details{ You can include headers within the \code{navlistPanel} by including - plain text elements in the list. Versions of Shiny before 0.11 supported - separators with "------", but as of 0.11, separators were no longer - supported. This is because version 0.11 switched to Bootstrap 3, which - doesn't support separators. +plain text elements in the list. Versions of Shiny before 0.11 supported +separators with "------", but as of 0.11, separators were no longer +supported. This is because version 0.11 switched to Bootstrap 3, which +doesn't support separators. } \examples{ fluidPage( @@ -54,5 +54,5 @@ fluidPage( } \seealso{ \code{\link{tabPanel}}, \code{\link{updateNavlistPanel}}, - \code{\link{insertTab}}, \code{\link{showTab}} +\code{\link{insertTab}}, \code{\link{showTab}} } diff --git a/man/observe.Rd b/man/observe.Rd index f112f3d56..82e7dbe14 100644 --- a/man/observe.Rd +++ b/man/observe.Rd @@ -42,40 +42,40 @@ automatically destroyed when its domain (if any) ends.} } \value{ An observer reference class object. This object has the following - methods: - \describe{ - \item{\code{suspend()}}{ - Causes this observer to stop scheduling flushes (re-executions) in - response to invalidations. If the observer was invalidated prior to - this call but it has not re-executed yet then that re-execution will - still occur, because the flush is already scheduled. - } - \item{\code{resume()}}{ - Causes this observer to start re-executing in response to - invalidations. If the observer was invalidated while suspended, then it - will schedule itself for re-execution. - } - \item{\code{destroy()}}{ - Stops the observer from executing ever again, even if it is currently - scheduled for re-execution. - } - \item{\code{setPriority(priority = 0)}}{ - Change this observer's priority. Note that if the observer is currently - invalidated, then the change in priority will not take effect until the - next invalidation--unless the observer is also currently suspended, in - which case the priority change will be effective upon resume. - } - \item{\code{setAutoDestroy(autoDestroy)}}{ - Sets whether this observer should be automatically destroyed when its - domain (if any) ends. If autoDestroy is TRUE and the domain already - ended, then destroy() is called immediately." - } - \item{\code{onInvalidate(callback)}}{ - Register a callback function to run when this observer is invalidated. - No arguments will be provided to the callback function when it is - invoked. - } - } +methods: +\describe{ +\item{\code{suspend()}}{ +Causes this observer to stop scheduling flushes (re-executions) in +response to invalidations. If the observer was invalidated prior to +this call but it has not re-executed yet then that re-execution will +still occur, because the flush is already scheduled. +} +\item{\code{resume()}}{ +Causes this observer to start re-executing in response to +invalidations. If the observer was invalidated while suspended, then it +will schedule itself for re-execution. +} +\item{\code{destroy()}}{ +Stops the observer from executing ever again, even if it is currently +scheduled for re-execution. +} +\item{\code{setPriority(priority = 0)}}{ +Change this observer's priority. Note that if the observer is currently +invalidated, then the change in priority will not take effect until the +next invalidation--unless the observer is also currently suspended, in +which case the priority change will be effective upon resume. +} +\item{\code{setAutoDestroy(autoDestroy)}}{ +Sets whether this observer should be automatically destroyed when its +domain (if any) ends. If autoDestroy is TRUE and the domain already +ended, then destroy() is called immediately." +} +\item{\code{onInvalidate(callback)}}{ +Register a callback function to run when this observer is invalidated. +No arguments will be provided to the callback function when it is +invoked. +} +} } \description{ Creates an observer from the given expression. diff --git a/man/observeEvent.Rd b/man/observeEvent.Rd index 246b382f7..8dc36b0a4 100644 --- a/man/observeEvent.Rd +++ b/man/observeEvent.Rd @@ -87,8 +87,8 @@ that is stored in a variable; to do so, it must be quoted with \code{quote()}.} } \value{ \code{observeEvent} returns an observer reference class object (see - \code{\link{observe}}). \code{eventReactive} returns a reactive expression - object (see \code{\link{reactive}}). +\code{\link{observe}}). \code{eventReactive} returns a reactive expression +object (see \code{\link{reactive}}). } \description{ Respond to "event-like" reactive inputs, values, and expressions. @@ -157,30 +157,30 @@ purposes they are independent from one another. Here's the result of combining these: \describe{ - \item{\code{ignoreNULL = TRUE} and \code{ignoreInit = FALSE}}{ - This is the default. This combination means that \code{handlerExpr}/ - \code{valueExpr} will run every time that \code{eventExpr} is not - \code{NULL}. If, at the time of the creation of the - \code{observeEvent}/\code{eventReactive}, \code{eventExpr} happens - to \emph{not} be \code{NULL}, then the code runs. - } - \item{\code{ignoreNULL = FALSE} and \code{ignoreInit = FALSE}}{ - This combination means that \code{handlerExpr}/\code{valueExpr} will - run every time no matter what. - } - \item{\code{ignoreNULL = FALSE} and \code{ignoreInit = TRUE}}{ - This combination means that \code{handlerExpr}/\code{valueExpr} will - \emph{not} run when the \code{observeEvent}/\code{eventReactive} is - created (because \code{ignoreInit = TRUE}), but it will run every - other time. - } - \item{\code{ignoreNULL = TRUE} and \code{ignoreInit = TRUE}}{ - This combination means that \code{handlerExpr}/\code{valueExpr} will - \emph{not} run when the \code{observeEvent}/\code{eventReactive} is - created (because \code{ignoreInit = TRUE}). After that, - \code{handlerExpr}/\code{valueExpr} will run every time that - \code{eventExpr} is not \code{NULL}. - } +\item{\code{ignoreNULL = TRUE} and \code{ignoreInit = FALSE}}{ +This is the default. This combination means that \code{handlerExpr}/ +\code{valueExpr} will run every time that \code{eventExpr} is not +\code{NULL}. If, at the time of the creation of the +\code{observeEvent}/\code{eventReactive}, \code{eventExpr} happens +to \emph{not} be \code{NULL}, then the code runs. +} +\item{\code{ignoreNULL = FALSE} and \code{ignoreInit = FALSE}}{ +This combination means that \code{handlerExpr}/\code{valueExpr} will +run every time no matter what. +} +\item{\code{ignoreNULL = FALSE} and \code{ignoreInit = TRUE}}{ +This combination means that \code{handlerExpr}/\code{valueExpr} will +\emph{not} run when the \code{observeEvent}/\code{eventReactive} is +created (because \code{ignoreInit = TRUE}), but it will run every +other time. +} +\item{\code{ignoreNULL = TRUE} and \code{ignoreInit = TRUE}}{ +This combination means that \code{handlerExpr}/\code{valueExpr} will +\emph{not} run when the \code{observeEvent}/\code{eventReactive} is +created (because \code{ignoreInit = TRUE}). After that, +\code{handlerExpr}/\code{valueExpr} will run every time that +\code{eventExpr} is not \code{NULL}. +} } } diff --git a/man/onBookmark.Rd b/man/onBookmark.Rd index ae2366ce5..23ad28193 100644 --- a/man/onBookmark.Rd +++ b/man/onBookmark.Rd @@ -25,19 +25,19 @@ These functions are for registering callbacks on Shiny session events. They should be called within an application's server function. \itemize{ - \item \code{onBookmark} registers a function that will be called just - before Shiny bookmarks state. - \item \code{onBookmarked} registers a function that will be called just - after Shiny bookmarks state. - \item \code{onRestore} registers a function that will be called when a - session is restored, after the server function executes, but before all - other reactives, observers and render functions are run. - \item \code{onRestored} registers a function that will be called after a - session is restored. This is similar to \code{onRestore}, but it will be - called after all reactives, observers, and render functions run, and - after results are sent to the client browser. \code{onRestored} - callbacks can be useful for sending update messages to the client - browser. +\item \code{onBookmark} registers a function that will be called just +before Shiny bookmarks state. +\item \code{onBookmarked} registers a function that will be called just +after Shiny bookmarks state. +\item \code{onRestore} registers a function that will be called when a +session is restored, after the server function executes, but before all +other reactives, observers and render functions are run. +\item \code{onRestored} registers a function that will be called after a +session is restored. This is similar to \code{onRestore}, but it will be +called after all reactives, observers, and render functions run, and +after results are sent to the client browser. \code{onRestored} +callbacks can be useful for sending update messages to the client +browser. } } \details{ @@ -71,10 +71,10 @@ then Shiny will by default display a modal dialog with the bookmark URL. \section{Modules}{ - These callbacks may also be used in Shiny modules. When used this way, the - inputs and values will automatically be namespaced for the module, and the - callback functions registered for the module will only be able to see the - module's inputs and values. +These callbacks may also be used in Shiny modules. When used this way, the +inputs and values will automatically be namespaced for the module, and the +callback functions registered for the module will only be able to see the +module's inputs and values. } \examples{ diff --git a/man/onFlush.Rd b/man/onFlush.Rd index c037f3a41..8f915d054 100644 --- a/man/onFlush.Rd +++ b/man/onFlush.Rd @@ -36,5 +36,5 @@ arguments to cancel the registration. } \seealso{ \code{\link{onStop}()} for registering callbacks that will be - invoked when the application exits, or when a session ends. +invoked when the application exits, or when a session ends. } diff --git a/man/onStop.Rd b/man/onStop.Rd index 8835f43f1..082b668d6 100644 --- a/man/onStop.Rd +++ b/man/onStop.Rd @@ -79,5 +79,5 @@ onStop(function() { } \seealso{ \code{\link{onSessionEnded}()} for the same functionality, but at - the session level only. +the session level only. } diff --git a/man/outputOptions.Rd b/man/outputOptions.Rd index 0cb2ee644..d802b723e 100644 --- a/man/outputOptions.Rd +++ b/man/outputOptions.Rd @@ -16,12 +16,12 @@ outputOptions(x, name, ...) \description{ These are the available options for an output object: \itemize{ - \item suspendWhenHidden. When \code{TRUE} (the default), the output object - will be suspended (not execute) when it is hidden on the web page. When - \code{FALSE}, the output object will not suspend when hidden, and if it - was already hidden and suspended, then it will resume immediately. - \item priority. The priority level of the output object. Queued outputs - with higher priority values will execute before those with lower values. +\item suspendWhenHidden. When \code{TRUE} (the default), the output object +will be suspended (not execute) when it is hidden on the web page. When +\code{FALSE}, the output object will not suspend when hidden, and if it +was already hidden and suspended, then it will resume immediately. +\item priority. The priority level of the output object. Queued outputs +with higher priority values will execute before those with lower values. } } \examples{ diff --git a/man/parseQueryString.Rd b/man/parseQueryString.Rd index 5b9a516fd..7539387e3 100644 --- a/man/parseQueryString.Rd +++ b/man/parseQueryString.Rd @@ -12,9 +12,9 @@ parseQueryString(str, nested = FALSE) \item{nested}{Whether to parse the query string of as a nested list when it contains pairs of square brackets \code{[]}. For example, the query \samp{a[i1][j1]=x&b[i1][j1]=y&b[i2][j1]=z} will be parsed as \code{list(a = -list(i1 = list(j1 = 'x')), b = list(i1 = list(j1 = 'y'), i2 = list(j1 = -'z')))} when \code{nested = TRUE}, and \code{list(`a[i1][j1]` = 'x', -`b[i1][j1]` = 'y', `b[i2][j1]` = 'z')} when \code{nested = FALSE}.} + list(i1 = list(j1 = 'x')), b = list(i1 = list(j1 = 'y'), i2 = list(j1 = + 'z')))} when \code{nested = TRUE}, and \code{list(`a[i1][j1]` = 'x', + `b[i1][j1]` = 'y', `b[i2][j1]` = 'z')} when \code{nested = FALSE}.} } \description{ Returns a named list of key-value pairs. diff --git a/man/plotOutput.Rd b/man/plotOutput.Rd index 9938997e0..7cbe99ce2 100644 --- a/man/plotOutput.Rd +++ b/man/plotOutput.Rd @@ -86,30 +86,30 @@ application page. } \note{ The arguments \code{clickId} and \code{hoverId} only work for R base - graphics (see the \pkg{\link[graphics:graphics-package]{graphics}} package). They do not work for - \pkg{\link[grid:grid-package]{grid}}-based graphics, such as \pkg{ggplot2}, - \pkg{lattice}, and so on. +graphics (see the \pkg{\link[graphics:graphics-package]{graphics}} package). They do not work for +\pkg{\link[grid:grid-package]{grid}}-based graphics, such as \pkg{ggplot2}, +\pkg{lattice}, and so on. } \section{Interactive plots}{ - Plots and images in Shiny support mouse-based interaction, via clicking, - double-clicking, hovering, and brushing. When these interaction events - occur, the mouse coordinates will be sent to the server as \code{input$} - variables, as specified by \code{click}, \code{dblclick}, \code{hover}, or - \code{brush}. +Plots and images in Shiny support mouse-based interaction, via clicking, +double-clicking, hovering, and brushing. When these interaction events +occur, the mouse coordinates will be sent to the server as \code{input$} +variables, as specified by \code{click}, \code{dblclick}, \code{hover}, or +\code{brush}. - For \code{plotOutput}, the coordinates will be sent scaled to the data - space, if possible. (At the moment, plots generated by base graphics and - ggplot2 support this scaling, although plots generated by lattice and - others do not.) If scaling is not possible, the raw pixel coordinates will - be sent. For \code{imageOutput}, the coordinates will be sent in raw pixel - coordinates. +For \code{plotOutput}, the coordinates will be sent scaled to the data +space, if possible. (At the moment, plots generated by base graphics and +ggplot2 support this scaling, although plots generated by lattice and +others do not.) If scaling is not possible, the raw pixel coordinates will +be sent. For \code{imageOutput}, the coordinates will be sent in raw pixel +coordinates. - With ggplot2 graphics, the code in \code{renderPlot} should return a ggplot - object; if instead the code prints the ggplot2 object with something like - \code{print(p)}, then the coordinates for interactive graphics will not be - properly scaled to the data space. +With ggplot2 graphics, the code in \code{renderPlot} should return a ggplot +object; if instead the code prints the ggplot2 object with something like +\code{print(p)}, then the coordinates for interactive graphics will not be +properly scaled to the data space. } \examples{ @@ -273,5 +273,5 @@ shinyApp( } \seealso{ For the corresponding server-side functions, see - \code{\link{renderPlot}} and \code{\link{renderImage}}. +\code{\link{renderPlot}} and \code{\link{renderImage}}. } diff --git a/man/reactiveFileReader.Rd b/man/reactiveFileReader.Rd index a5f46b481..22bc9741e 100644 --- a/man/reactiveFileReader.Rd +++ b/man/reactiveFileReader.Rd @@ -28,8 +28,8 @@ invoked.} } \value{ A reactive expression that returns the contents of the file, and - automatically invalidates when the file changes on disk (as determined by - last modified time). +automatically invalidates when the file changes on disk (as determined by +last modified time). } \description{ Given a file path and read function, returns a reactive data source for the diff --git a/man/reactivePoll.Rd b/man/reactivePoll.Rd index daa2f335a..bcd3a23fa 100644 --- a/man/reactivePoll.Rd +++ b/man/reactivePoll.Rd @@ -25,7 +25,7 @@ Details.} } \value{ A reactive expression that returns the result of \code{valueFunc}, - and invalidates when \code{checkFunc} changes. +and invalidates when \code{checkFunc} changes. } \description{ Used to create a reactive data source, which works by periodically polling a diff --git a/man/reactiveTimer.Rd b/man/reactiveTimer.Rd index 27b6a0188..3d5d1e619 100644 --- a/man/reactiveTimer.Rd +++ b/man/reactiveTimer.Rd @@ -16,9 +16,9 @@ occur.} } \value{ A no-parameter function that can be called from a reactive context, - in order to cause that context to be invalidated the next time the timer - interval elapses. Calling the returned function also happens to yield the - current time (as in \code{\link[base]{Sys.time}}). +in order to cause that context to be invalidated the next time the timer +interval elapses. Calling the returned function also happens to yield the +current time (as in \code{\link[base]{Sys.time}}). } \description{ Creates a reactive timer with the given interval. A reactive timer is like a diff --git a/man/reactiveVal.Rd b/man/reactiveVal.Rd index f074fa10f..db3e806c6 100644 --- a/man/reactiveVal.Rd +++ b/man/reactiveVal.Rd @@ -15,7 +15,7 @@ created.} } \value{ A function. Call the function with no arguments to (reactively) read - the value; call the function with a single argument to set the value. +the value; call the function with a single argument to set the value. } \description{ The \code{reactiveVal} function is used to construct a "reactive value" diff --git a/man/registerInputHandler.Rd b/man/registerInputHandler.Rd index 5ba1e1dae..d7ed996d3 100644 --- a/man/registerInputHandler.Rd +++ b/man/registerInputHandler.Rd @@ -14,12 +14,12 @@ single-element character vector.} parse the data delivered from the client before it is available in the \code{input} variable. The function will be called with the following three parameters: - \enumerate{ - \item{The value of this input as provided by the client, deserialized - using jsonlite.} - \item{The \code{shinysession} in which the input exists.} - \item{The name of the input.} - }} +\enumerate{ +\item{The value of this input as provided by the client, deserialized +using jsonlite.} +\item{The \code{shinysession} in which the input exists.} +\item{The name of the input.} +}} \item{force}{If \code{TRUE}, will overwrite any existing handler without warning. If \code{FALSE}, will throw an error if this class already has diff --git a/man/removeInputHandler.Rd b/man/removeInputHandler.Rd index add1a4489..0a4d4455e 100644 --- a/man/removeInputHandler.Rd +++ b/man/removeInputHandler.Rd @@ -11,7 +11,7 @@ removeInputHandler(type) } \value{ The handler previously associated with this \code{type}, if one - existed. Otherwise, \code{NULL}. +existed. Otherwise, \code{NULL}. } \description{ Removes an Input Handler. Rather than using the previously specified handler diff --git a/man/renderCachedPlot.Rd b/man/renderCachedPlot.Rd index af16adaba..1fec60573 100644 --- a/man/renderCachedPlot.Rd +++ b/man/renderCachedPlot.Rd @@ -81,55 +81,55 @@ will not have cache key collisions. \section{Cache scoping}{ - There are a number of different ways you may want to scope the cache. For - example, you may want each user session to have their own plot cache, or - you may want each run of the application to have a cache (shared among - possibly multiple simultaneous user sessions), or you may want to have a - cache that persists even after the application is shut down and started - again. +There are a number of different ways you may want to scope the cache. For +example, you may want each user session to have their own plot cache, or +you may want each run of the application to have a cache (shared among +possibly multiple simultaneous user sessions), or you may want to have a +cache that persists even after the application is shut down and started +again. - To control the scope of the cache, use the \code{cache} parameter. There - are two ways of having Shiny automatically create and clean up the disk - cache. +To control the scope of the cache, use the \code{cache} parameter. There +are two ways of having Shiny automatically create and clean up the disk +cache. \describe{ - \item{1}{To scope the cache to one run of a Shiny application (shared - among possibly multiple user sessions), use \code{cache="app"}. This - is the default. The cache will be shared across multiple sessions, so - there is potentially a large performance benefit if there are many users - of the application. When the application stops running, the cache will - be deleted. If plots cannot be safely shared across users, this should - not be used.} - \item{2}{To scope the cache to one session, use \code{cache="session"}. - When a new user session starts -- in other words, when a web browser - visits the Shiny application -- a new cache will be created on disk - for that session. When the session ends, the cache will be deleted. - The cache will not be shared across multiple sessions.} - } +\item{1}{To scope the cache to one run of a Shiny application (shared +among possibly multiple user sessions), use \code{cache="app"}. This +is the default. The cache will be shared across multiple sessions, so +there is potentially a large performance benefit if there are many users +of the application. When the application stops running, the cache will +be deleted. If plots cannot be safely shared across users, this should +not be used.} +\item{2}{To scope the cache to one session, use \code{cache="session"}. +When a new user session starts -- in other words, when a web browser +visits the Shiny application -- a new cache will be created on disk +for that session. When the session ends, the cache will be deleted. +The cache will not be shared across multiple sessions.} +} - If either \code{"app"} or \code{"session"} is used, the cache will be 10 MB - in size, and will be stored stored in memory, using a - \code{\link{memoryCache}} object. Note that the cache space will be shared - among all cached plots within a single application or session. +If either \code{"app"} or \code{"session"} is used, the cache will be 10 MB +in size, and will be stored stored in memory, using a +\code{\link{memoryCache}} object. Note that the cache space will be shared +among all cached plots within a single application or session. - In some cases, you may want more control over the caching behavior. For - example, you may want to use a larger or smaller cache, share a cache - among multiple R processes, or you may want the cache to persist across - multiple runs of an application, or even across multiple R processes. +In some cases, you may want more control over the caching behavior. For +example, you may want to use a larger or smaller cache, share a cache +among multiple R processes, or you may want the cache to persist across +multiple runs of an application, or even across multiple R processes. - To use different settings for an application-scoped cache, you can call - \code{\link{shinyOptions}()} at the top of your app.R, server.R, or - global.R. For example, this will create a cache with 20 MB of space - instead of the default 10 MB: - \preformatted{ +To use different settings for an application-scoped cache, you can call +\code{\link{shinyOptions}()} at the top of your app.R, server.R, or +global.R. For example, this will create a cache with 20 MB of space +instead of the default 10 MB: +\preformatted{ shinyOptions(cache = memoryCache(size = 20e6)) } - To use different settings for a session-scoped cache, you can call - \code{\link{shinyOptions}()} at the top of your server function. To use - the session-scoped cache, you must also call \code{renderCachedPlot} with - \code{cache="session"}. This will create a 20 MB cache for the session: - \preformatted{ +To use different settings for a session-scoped cache, you can call +\code{\link{shinyOptions}()} at the top of your server function. To use +the session-scoped cache, you must also call \code{renderCachedPlot} with +\code{cache="session"}. This will create a 20 MB cache for the session: +\preformatted{ function(input, output, session) { shinyOptions(cache = memoryCache(size = 20e6)) @@ -140,40 +140,40 @@ will not have cache key collisions. } } - If you want to create a cache that is shared across multiple concurrent - R processes, you can use a \code{\link{diskCache}}. You can create an - application-level shared cache by putting this at the top of your app.R, - server.R, or global.R: - \preformatted{ +If you want to create a cache that is shared across multiple concurrent +R processes, you can use a \code{\link{diskCache}}. You can create an +application-level shared cache by putting this at the top of your app.R, +server.R, or global.R: +\preformatted{ shinyOptions(cache = diskCache(file.path(dirname(tempdir()), "myapp-cache")) } - This will create a subdirectory in your system temp directory named - \code{myapp-cache} (replace \code{myapp-cache} with a unique name of - your choosing). On most platforms, this directory will be removed when - your system reboots. This cache will persist across multiple starts and - stops of the R process, as long as you do not reboot. +This will create a subdirectory in your system temp directory named +\code{myapp-cache} (replace \code{myapp-cache} with a unique name of +your choosing). On most platforms, this directory will be removed when +your system reboots. This cache will persist across multiple starts and +stops of the R process, as long as you do not reboot. - To have the cache persist even across multiple reboots, you can create the - cache in a location outside of the temp directory. For example, it could - be a subdirectory of the application: - \preformatted{ +To have the cache persist even across multiple reboots, you can create the +cache in a location outside of the temp directory. For example, it could +be a subdirectory of the application: +\preformatted{ shinyOptions(cache = diskCache("./myapp-cache")) } - In this case, resetting the cache will have to be done manually, by deleting - the directory. +In this case, resetting the cache will have to be done manually, by deleting +the directory. - You can also scope a cache to just one plot, or selected plots. To do that, - create a \code{\link{memoryCache}} or \code{\link{diskCache}}, and pass it - as the \code{cache} argument of \code{renderCachedPlot}. +You can also scope a cache to just one plot, or selected plots. To do that, +create a \code{\link{memoryCache}} or \code{\link{diskCache}}, and pass it +as the \code{cache} argument of \code{renderCachedPlot}. } \section{Interactive plots}{ - \code{renderCachedPlot} can be used to create interactive plots. See - \code{\link{plotOutput}} for more information and examples. +\code{renderCachedPlot} can be used to create interactive plots. See +\code{\link{plotOutput}} for more information and examples. } \examples{ @@ -311,6 +311,6 @@ server <- function(input, output, session) { } \seealso{ See \code{\link{renderPlot}} for the regular, non-cached version of - this function. For more about configuring caches, see - \code{\link{memoryCache}} and \code{\link{diskCache}}. +this function. For more about configuring caches, see +\code{\link{memoryCache}} and \code{\link{diskCache}}. } diff --git a/man/renderDataTable.Rd b/man/renderDataTable.Rd index c237566b1..4a6275d9f 100644 --- a/man/renderDataTable.Rd +++ b/man/renderDataTable.Rd @@ -54,12 +54,12 @@ elements in the list. } \note{ This function only provides the server-side version of DataTables - (using R to process the data object on the server side). There is a - separate package \pkg{DT} (\url{https://github.com/rstudio/DT}) that allows - you to create both server-side and client-side DataTables, and supports - additional DataTables features. Consider using \code{DT::renderDataTable()} - and \code{DT::dataTableOutput()} (see - \url{http://rstudio.github.io/DT/shiny.html} for more information). +(using R to process the data object on the server side). There is a +separate package \pkg{DT} (\url{https://github.com/rstudio/DT}) that allows +you to create both server-side and client-side DataTables, and supports +additional DataTables features. Consider using \code{DT::renderDataTable()} +and \code{DT::dataTableOutput()} (see +\url{http://rstudio.github.io/DT/shiny.html} for more information). } \examples{ ## Only run this example in interactive R sessions diff --git a/man/renderImage.Rd b/man/renderImage.Rd index 2350d73ca..0eb62f045 100644 --- a/man/renderImage.Rd +++ b/man/renderImage.Rd @@ -113,5 +113,5 @@ shinyApp(ui, server) } \seealso{ For more details on how the images are generated, and how to control - the output, see \code{\link{plotPNG}}. +the output, see \code{\link{plotPNG}}. } diff --git a/man/renderPlot.Rd b/man/renderPlot.Rd index c49e2676a..16e349a7c 100644 --- a/man/renderPlot.Rd +++ b/man/renderPlot.Rd @@ -53,18 +53,18 @@ the CSS class name \code{shiny-plot-output}. \section{Interactive plots}{ - With ggplot2 graphics, the code in \code{renderPlot} should return a ggplot - object; if instead the code prints the ggplot2 object with something like - \code{print(p)}, then the coordinates for interactive graphics will not be - properly scaled to the data space. +With ggplot2 graphics, the code in \code{renderPlot} should return a ggplot +object; if instead the code prints the ggplot2 object with something like +\code{print(p)}, then the coordinates for interactive graphics will not be +properly scaled to the data space. - See \code{\link{plotOutput}} for more information about interactive plots. +See \code{\link{plotOutput}} for more information about interactive plots. } \seealso{ For the corresponding client-side output function, and example - usage, see \code{\link{plotOutput}}. For more details on how the plots are - generated, and how to control the output, see \code{\link{plotPNG}}. - \code{\link{renderCachedPlot}} offers a way to cache generated plots to - expedite the rendering of identical plots. +usage, see \code{\link{plotOutput}}. For more details on how the plots are +generated, and how to control the output, see \code{\link{plotPNG}}. +\code{\link{renderCachedPlot}} offers a way to cache generated plots to +expedite the rendering of identical plots. } diff --git a/man/renderPrint.Rd b/man/renderPrint.Rd index 36f15e7c8..eea54b60c 100644 --- a/man/renderPrint.Rd +++ b/man/renderPrint.Rd @@ -106,5 +106,5 @@ vecFun() } \seealso{ \code{\link{renderText}} for displaying the value returned from a - function, instead of the printed output. +function, instead of the printed output. } diff --git a/man/renderText.Rd b/man/renderText.Rd index 810658c5d..14ce976f3 100644 --- a/man/renderText.Rd +++ b/man/renderText.Rd @@ -102,5 +102,5 @@ vecFun() } \seealso{ \code{\link{renderPrint}} for capturing the print output of a - function, rather than the returned text value. +function, rather than the returned text value. } diff --git a/man/repeatable.Rd b/man/repeatable.Rd index 5cd024686..8edc5dc9a 100644 --- a/man/repeatable.Rd +++ b/man/repeatable.Rd @@ -21,8 +21,8 @@ be passed in explicitly if desired; otherwise, a random number is used. } \note{ When called, the returned function attempts to preserve the R session's - current seed by snapshotting and restoring - \code{\link[base]{.Random.seed}}. +current seed by snapshotting and restoring +\code{\link[base]{.Random.seed}}. } \examples{ rnormA <- repeatable(rnorm) diff --git a/man/req.Rd b/man/req.Rd index 62153027c..a7c0c8739 100644 --- a/man/req.Rd +++ b/man/req.Rd @@ -73,14 +73,14 @@ To be precise, \code{req} considers a value truthy \emph{unless} it is one of: \itemize{ - \item{\code{FALSE}} - \item{\code{NULL}} - \item{\code{""}} - \item{An empty atomic vector} - \item{An atomic vector that contains only missing values} - \item{A logical vector that contains all \code{FALSE} or missing values} - \item{An object of class \code{"try-error"}} - \item{A value that represents an unclicked \code{\link{actionButton}}} +\item{\code{FALSE}} +\item{\code{NULL}} +\item{\code{""}} +\item{An empty atomic vector} +\item{An atomic vector that contains only missing values} +\item{A logical vector that contains all \code{FALSE} or missing values} +\item{An object of class \code{"try-error"}} +\item{A value that represents an unclicked \code{\link{actionButton}}} } Note in particular that the value \code{0} is considered truthy, even though diff --git a/man/runApp.Rd b/man/runApp.Rd index a86d2fe8c..d68bdb8f3 100644 --- a/man/runApp.Rd +++ b/man/runApp.Rd @@ -14,10 +14,10 @@ runApp(appDir = getwd(), port = getOption("shiny.port"), \item{appDir}{The application to run. Should be one of the following: \itemize{ \item A directory containing \code{server.R}, plus, either \code{ui.R} or - a \code{www} directory that contains the file \code{index.html}. +a \code{www} directory that contains the file \code{index.html}. \item A directory containing \code{app.R}. \item An \code{.R} file containing a Shiny application, ending with an - expression that produces a Shiny app object. +expression that produces a Shiny app object. \item A list with \code{ui} and \code{server} components. \item A Shiny app object created by \code{\link{shinyApp}}. }} diff --git a/man/selectInput.Rd b/man/selectInput.Rd index 47c0b2e1b..3fe4a5ae8 100644 --- a/man/selectInput.Rd +++ b/man/selectInput.Rd @@ -66,13 +66,13 @@ In selectize mode, if the first element in \code{choices} has a value of } \note{ The selectize input created from \code{selectizeInput()} allows - deletion of the selected option even in a single select input, which will - return an empty string as its value. This is the default behavior of - \pkg{selectize.js}. However, the selectize input created from - \code{selectInput(..., selectize = TRUE)} will ignore the empty string - value when it is a single choice input and the empty string is not in the - \code{choices} argument. This is to keep compatibility with - \code{selectInput(..., selectize = FALSE)}. +deletion of the selected option even in a single select input, which will +return an empty string as its value. This is the default behavior of +\pkg{selectize.js}. However, the selectize input created from +\code{selectInput(..., selectize = TRUE)} will ignore the empty string +value when it is a single choice input and the empty string is not in the +\code{choices} argument. This is to keep compatibility with +\code{selectInput(..., selectize = FALSE)}. } \examples{ ## Only run examples in interactive R sessions diff --git a/man/session.Rd b/man/session.Rd index 9848677c2..b26df982f 100644 --- a/man/session.Rd +++ b/man/session.Rd @@ -5,174 +5,174 @@ \title{Session object} \value{ \item{allowReconnect(value)}{ - If \code{value} is \code{TRUE} and run in a hosting environment (Shiny - Server or Connect) with reconnections enabled, then when the session ends - due to the network connection closing, the client will attempt to - reconnect to the server. If a reconnection is successful, the browser will - send all the current input values to the new session on the server, and - the server will recalculate any outputs and send them back to the client. - If \code{value} is \code{FALSE}, reconnections will be disabled (this is - the default state). If \code{"force"}, then the client browser will always - attempt to reconnect. The only reason to use \code{"force"} is for testing - on a local connection (without Shiny Server or Connect). +If \code{value} is \code{TRUE} and run in a hosting environment (Shiny +Server or Connect) with reconnections enabled, then when the session ends +due to the network connection closing, the client will attempt to +reconnect to the server. If a reconnection is successful, the browser will +send all the current input values to the new session on the server, and +the server will recalculate any outputs and send them back to the client. +If \code{value} is \code{FALSE}, reconnections will be disabled (this is +the default state). If \code{"force"}, then the client browser will always +attempt to reconnect. The only reason to use \code{"force"} is for testing +on a local connection (without Shiny Server or Connect). } \item{clientData}{ - A \code{\link{reactiveValues}} object that contains information about the client. - \itemize{ - \item{\code{allowDataUriScheme} is a logical value that indicates whether - the browser is able to handle URIs that use the \code{data:} scheme. - } - \item{\code{pixelratio} reports the "device pixel ratio" from the web browser, - or 1 if none is reported. The value is 2 for Apple Retina displays. - } - \item{\code{singletons} - for internal use} - \item{\code{url_protocol}, \code{url_hostname}, \code{url_port}, - \code{url_pathname}, \code{url_search}, \code{url_hash_initial} - and \code{url_hash} can be used to get the components of the URL - that was requested by the browser to load the Shiny app page. - These values are from the browser's perspective, so neither HTTP - proxies nor Shiny Server will affect these values. The - \code{url_search} value may be used with \code{\link{parseQueryString}} - to access query string parameters. - } - } - \code{clientData} also contains information about each output. - \code{output_\var{outputId}_width} and \code{output_\var{outputId}_height} - give the dimensions (using \code{offsetWidth} and \code{offsetHeight}) of - the DOM element that is bound to \code{\var{outputId}}, and - \code{output_\var{outputId}_hidden} is a logical that indicates whether - the element is hidden. These values may be \code{NULL} if the output is - not bound. +A \code{\link{reactiveValues}} object that contains information about the client. +\itemize{ +\item{\code{allowDataUriScheme} is a logical value that indicates whether +the browser is able to handle URIs that use the \code{data:} scheme. +} +\item{\code{pixelratio} reports the "device pixel ratio" from the web browser, +or 1 if none is reported. The value is 2 for Apple Retina displays. +} +\item{\code{singletons} - for internal use} +\item{\code{url_protocol}, \code{url_hostname}, \code{url_port}, +\code{url_pathname}, \code{url_search}, \code{url_hash_initial} +and \code{url_hash} can be used to get the components of the URL +that was requested by the browser to load the Shiny app page. +These values are from the browser's perspective, so neither HTTP +proxies nor Shiny Server will affect these values. The +\code{url_search} value may be used with \code{\link{parseQueryString}} +to access query string parameters. +} +} +\code{clientData} also contains information about each output. +\code{output_\var{outputId}_width} and \code{output_\var{outputId}_height} +give the dimensions (using \code{offsetWidth} and \code{offsetHeight}) of +the DOM element that is bound to \code{\var{outputId}}, and +\code{output_\var{outputId}_hidden} is a logical that indicates whether +the element is hidden. These values may be \code{NULL} if the output is +not bound. } \item{input}{ - The session's \code{input} object (the same as is passed into the Shiny - server function as an argument). +The session's \code{input} object (the same as is passed into the Shiny +server function as an argument). } \item{isClosed()}{A function that returns \code{TRUE} if the client has - disconnected. +disconnected. } \item{ns(id)}{ - Server-side version of \code{ns <- \link{NS}(id)}. If bare IDs need to be - explicitly namespaced for the current module, \code{session$ns("name")} - will return the fully-qualified ID. +Server-side version of \code{ns <- \link{NS}(id)}. If bare IDs need to be +explicitly namespaced for the current module, \code{session$ns("name")} +will return the fully-qualified ID. } \item{onEnded(callback)}{ - Synonym for \code{onSessionEnded}. +Synonym for \code{onSessionEnded}. } \item{onFlush(func, once=TRUE)}{ - Registers a function to be called before the next time (if \code{once=TRUE}) - or every time (if \code{once=FALSE}) Shiny flushes the reactive system. - Returns a function that can be called with no arguments to cancel the - registration. +Registers a function to be called before the next time (if \code{once=TRUE}) +or every time (if \code{once=FALSE}) Shiny flushes the reactive system. +Returns a function that can be called with no arguments to cancel the +registration. } \item{onFlushed(func, once=TRUE)}{ - Registers a function to be called after the next time (if \code{once=TRUE}) - or every time (if \code{once=FALSE}) Shiny flushes the reactive system. - Returns a function that can be called with no arguments to cancel the - registration. +Registers a function to be called after the next time (if \code{once=TRUE}) +or every time (if \code{once=FALSE}) Shiny flushes the reactive system. +Returns a function that can be called with no arguments to cancel the +registration. } \item{onSessionEnded(callback)}{ - Registers a function to be called after the client has disconnected. - Returns a function that can be called with no arguments to cancel the - registration. +Registers a function to be called after the client has disconnected. +Returns a function that can be called with no arguments to cancel the +registration. } \item{output}{ - The session's \code{output} object (the same as is passed into the Shiny - server function as an argument). +The session's \code{output} object (the same as is passed into the Shiny +server function as an argument). } \item{reactlog}{ - For internal use. +For internal use. } \item{registerDataObj(name, data, filterFunc)}{ - Publishes any R object as a URL endpoint that is unique to this session. - \code{name} must be a single element character vector; it will be used - to form part of the URL. \code{filterFunc} must be a function that takes - two arguments: \code{data} (the value that was passed into - \code{registerDataObj}) and \code{req} (an environment that implements - the Rook specification for HTTP requests). \code{filterFunc} will be - called with these values whenever an HTTP request is made to the URL - endpoint. The return value of \code{filterFunc} should be a Rook-style - response. +Publishes any R object as a URL endpoint that is unique to this session. +\code{name} must be a single element character vector; it will be used +to form part of the URL. \code{filterFunc} must be a function that takes +two arguments: \code{data} (the value that was passed into +\code{registerDataObj}) and \code{req} (an environment that implements +the Rook specification for HTTP requests). \code{filterFunc} will be +called with these values whenever an HTTP request is made to the URL +endpoint. The return value of \code{filterFunc} should be a Rook-style +response. } \item{reload()}{ - The equivalent of hitting the browser's Reload button. Only works if the - session is actually connected. +The equivalent of hitting the browser's Reload button. Only works if the +session is actually connected. } \item{request}{ - An environment that implements the Rook specification for HTTP requests. - This is the request that was used to initiate the websocket connection - (as opposed to the request that downloaded the web page for the app). +An environment that implements the Rook specification for HTTP requests. +This is the request that was used to initiate the websocket connection +(as opposed to the request that downloaded the web page for the app). } \item{userData}{ - An environment for app authors and module/package authors to store whatever - session-specific data they want. +An environment for app authors and module/package authors to store whatever +session-specific data they want. } \item{resetBrush(brushId)}{ - Resets/clears the brush with the given \code{brushId}, if it exists on - any \code{imageOutput} or \code{plotOutput} in the app. +Resets/clears the brush with the given \code{brushId}, if it exists on +any \code{imageOutput} or \code{plotOutput} in the app. } \item{sendCustomMessage(type, message)}{ - Sends a custom message to the web page. \code{type} must be a - single-element character vector giving the type of message, while - \code{message} can be any jsonlite-encodable value. Custom messages - have no meaning to Shiny itself; they are used soley to convey information - to custom JavaScript logic in the browser. You can do this by adding - JavaScript code to the browser that calls - \code{Shiny.addCustomMessageHandler(type, function(message){...})} - as the page loads; the function you provide to - \code{addCustomMessageHandler} will be invoked each time - \code{sendCustomMessage} is called on the server. +Sends a custom message to the web page. \code{type} must be a +single-element character vector giving the type of message, while +\code{message} can be any jsonlite-encodable value. Custom messages +have no meaning to Shiny itself; they are used soley to convey information +to custom JavaScript logic in the browser. You can do this by adding +JavaScript code to the browser that calls +\code{Shiny.addCustomMessageHandler(type, function(message){...})} +as the page loads; the function you provide to +\code{addCustomMessageHandler} will be invoked each time +\code{sendCustomMessage} is called on the server. } \item{sendBinaryMessage(type, message)}{ - Similar to \code{sendCustomMessage}, but the message must be a raw vector - and the registration method on the client is - \code{Shiny.addBinaryMessageHandler(type, function(message){...})}. The - message argument on the client will be a - \href{https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView}{DataView}. +Similar to \code{sendCustomMessage}, but the message must be a raw vector +and the registration method on the client is +\code{Shiny.addBinaryMessageHandler(type, function(message){...})}. The +message argument on the client will be a +\href{https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView}{DataView}. } \item{sendInputMessage(inputId, message)}{ - Sends a message to an input on the session's client web page; if the input - is present and bound on the page at the time the message is received, then - the input binding object's \code{receiveMessage(el, message)} method will - be called. \code{sendInputMessage} should generally not be called directly - from Shiny apps, but through friendlier wrapper functions like - \code{\link{updateTextInput}}. +Sends a message to an input on the session's client web page; if the input +is present and bound on the page at the time the message is received, then +the input binding object's \code{receiveMessage(el, message)} method will +be called. \code{sendInputMessage} should generally not be called directly +from Shiny apps, but through friendlier wrapper functions like +\code{\link{updateTextInput}}. } \item{setBookmarkExclude(names)}{ - Set input names to be excluded from bookmarking. +Set input names to be excluded from bookmarking. } \item{getBookmarkExclude()}{ - Returns the set of input names to be excluded from bookmarking. +Returns the set of input names to be excluded from bookmarking. } \item{onBookmark(fun)}{ - Registers a function that will be called just before bookmarking state. +Registers a function that will be called just before bookmarking state. } \item{onBookmarked(fun)}{ - Registers a function that will be called just after bookmarking state. +Registers a function that will be called just after bookmarking state. } \item{onRestore(fun)}{ - Registers a function that will be called when a session is restored, before - all other reactives, observers, and render functions are run. +Registers a function that will be called when a session is restored, before +all other reactives, observers, and render functions are run. } \item{onRestored(fun)}{ - Registers a function that will be called when a session is restored, after - all other reactives, observers, and render functions are run. +Registers a function that will be called when a session is restored, after +all other reactives, observers, and render functions are run. } \item{doBookmark()}{ - Do bookmarking and invoke the onBookmark and onBookmarked callback functions. +Do bookmarking and invoke the onBookmark and onBookmarked callback functions. } \item{exportTestValues()}{ - Registers expressions for export in test mode, available at the test - snapshot URL. +Registers expressions for export in test mode, available at the test +snapshot URL. } \item{getTestSnapshotUrl(input=TRUE, output=TRUE, export=TRUE, - format="json")}{ - Returns a URL for the test snapshots. Only has an effect when the - \code{shiny.testmode} option is set to TRUE. For the input, output, and - export arguments, TRUE means to return all of these values. It is also - possible to specify by name which values to return by providing a - character vector, as in \code{input=c("x", "y")}. The format can be - "rds" or "json". +format="json")}{ +Returns a URL for the test snapshots. Only has an effect when the +\code{shiny.testmode} option is set to TRUE. For the input, output, and +export arguments, TRUE means to return all of these values. It is also +possible to specify by name which values to return by providing a +character vector, as in \code{input=c("x", "y")}. The format can be +"rds" or "json". } } \description{ diff --git a/man/shiny-options.Rd b/man/shiny-options.Rd index dc6689914..f6271a26a 100644 --- a/man/shiny-options.Rd +++ b/man/shiny-options.Rd @@ -9,80 +9,80 @@ be set with (for example) \code{options(shiny.trace=TRUE)}. } \details{ \describe{ - \item{shiny.launch.browser}{A boolean which controls the default behavior - when an app is run. See \code{\link{runApp}} for more information.} - \item{shiny.port}{A port number that Shiny will listen on. See - \code{\link{runApp}} for more information.} - \item{shiny.trace}{Print messages sent between the R server and the web - browser client to the R console. This is useful for debugging. Possible - values are \code{"send"} (only print messages sent to the client), - \code{"recv"} (only print messages received by the server), \code{TRUE} - (print all messages), or \code{FALSE} (default; don't print any of these - messages).} - \item{shiny.autoreload}{If \code{TRUE} when a Shiny app is launched, the - app directory will be continually monitored for changes to files that - have the extensions: r, htm, html, js, css, png, jpg, jpeg, gif. If any - changes are detected, all connected Shiny sessions are reloaded. This - allows for fast feedback loops when tweaking Shiny UI. +\item{shiny.launch.browser}{A boolean which controls the default behavior +when an app is run. See \code{\link{runApp}} for more information.} +\item{shiny.port}{A port number that Shiny will listen on. See +\code{\link{runApp}} for more information.} +\item{shiny.trace}{Print messages sent between the R server and the web +browser client to the R console. This is useful for debugging. Possible +values are \code{"send"} (only print messages sent to the client), +\code{"recv"} (only print messages received by the server), \code{TRUE} +(print all messages), or \code{FALSE} (default; don't print any of these +messages).} +\item{shiny.autoreload}{If \code{TRUE} when a Shiny app is launched, the +app directory will be continually monitored for changes to files that +have the extensions: r, htm, html, js, css, png, jpg, jpeg, gif. If any +changes are detected, all connected Shiny sessions are reloaded. This +allows for fast feedback loops when tweaking Shiny UI. Since monitoring for changes is expensive (we simply poll for last - modified times), this feature is intended only for development. +modified times), this feature is intended only for development. You can customize the file patterns Shiny will monitor by setting the - shiny.autoreload.pattern option. For example, to monitor only ui.R: - \code{options(shiny.autoreload.pattern = glob2rx("ui.R"))} +shiny.autoreload.pattern option. For example, to monitor only ui.R: +\code{options(shiny.autoreload.pattern = glob2rx("ui.R"))} The default polling interval is 500 milliseconds. You can change this - by setting e.g. \code{options(shiny.autoreload.interval = 2000)} (every - two seconds).} - \item{shiny.reactlog}{If \code{TRUE}, enable logging of reactive events, - which can be viewed later with the \code{\link{reactlogShow}} function. - This incurs a substantial performance penalty and should not be used in - production.} - \item{shiny.usecairo}{This is used to disable graphical rendering by the - Cairo package, if it is installed. See \code{\link{plotPNG}} for more - information.} - \item{shiny.maxRequestSize}{This is a number which specifies the maximum - web request size, which serves as a size limit for file uploads. If - unset, the maximum request size defaults to 5MB.} - \item{shiny.suppressMissingContextError}{Normally, invoking a reactive - outside of a reactive context (or \code{\link{isolate}()}) results in - an error. If this is \code{TRUE}, don't error in these cases. This - should only be used for debugging or demonstrations of reactivity at the - console.} - \item{shiny.host}{The IP address that Shiny should listen on. See - \code{\link{runApp}} for more information.} - \item{shiny.json.digits}{The number of digits to use when converting - numbers to JSON format to send to the client web browser.} - \item{shiny.minified}{If this is \code{TRUE} or unset (the default), then - Shiny will use minified JavaScript (\code{shiny.min.js}). If - \code{FALSE}, then Shiny will use the un-minified JavaScript - (\code{shiny.js}); this can be useful during development.} - \item{shiny.error}{This can be a function which is called when an error - occurs. For example, \code{options(shiny.error=recover)} will result a - the debugger prompt when an error occurs.} - \item{shiny.table.class}{CSS class names to use for tables.} - \item{shiny.deprecation.messages}{This controls whether messages for - deprecated functions in Shiny will be printed. See - \code{\link{shinyDeprecated}} for more information.} - \item{shiny.fullstacktrace}{Controls whether "pretty" or full stack traces - are dumped to the console when errors occur during Shiny app execution. - The default is \code{FALSE} (pretty stack traces).} - \item{shiny.stacktraceoffset}{If \code{TRUE}, then Shiny's printed stack - traces will display srcrefs one line above their usual location. This is - an arguably more intuitive arrangement for casual R users, as the name - of a function appears next to the srcref where it is defined, rather than - where it is currently being called from.} - \item{shiny.sanitize.errors}{If \code{TRUE}, then normal errors (i.e. - errors not wrapped in \code{safeError}) won't show up in the app; a simple - generic error message is printed instead (the error and strack trace printed - to the console remain unchanged). The default is \code{FALSE} (unsanitized - errors).If you want to sanitize errors in general, but you DO want a - particular error \code{e} to get displayed to the user, then set this option - to \code{TRUE} and use \code{stop(safeError(e))} for errors you want the - user to see.} - \item{shiny.testmode}{If \code{TRUE}, then enable features for testing Shiny - applications. If \code{FALSE} (the default), do not enable those features. - } +by setting e.g. \code{options(shiny.autoreload.interval = 2000)} (every +two seconds).} +\item{shiny.reactlog}{If \code{TRUE}, enable logging of reactive events, +which can be viewed later with the \code{\link{reactlogShow}} function. +This incurs a substantial performance penalty and should not be used in +production.} +\item{shiny.usecairo}{This is used to disable graphical rendering by the +Cairo package, if it is installed. See \code{\link{plotPNG}} for more +information.} +\item{shiny.maxRequestSize}{This is a number which specifies the maximum +web request size, which serves as a size limit for file uploads. If +unset, the maximum request size defaults to 5MB.} +\item{shiny.suppressMissingContextError}{Normally, invoking a reactive +outside of a reactive context (or \code{\link{isolate}()}) results in +an error. If this is \code{TRUE}, don't error in these cases. This +should only be used for debugging or demonstrations of reactivity at the +console.} +\item{shiny.host}{The IP address that Shiny should listen on. See +\code{\link{runApp}} for more information.} +\item{shiny.json.digits}{The number of digits to use when converting +numbers to JSON format to send to the client web browser.} +\item{shiny.minified}{If this is \code{TRUE} or unset (the default), then +Shiny will use minified JavaScript (\code{shiny.min.js}). If +\code{FALSE}, then Shiny will use the un-minified JavaScript +(\code{shiny.js}); this can be useful during development.} +\item{shiny.error}{This can be a function which is called when an error +occurs. For example, \code{options(shiny.error=recover)} will result a +the debugger prompt when an error occurs.} +\item{shiny.table.class}{CSS class names to use for tables.} +\item{shiny.deprecation.messages}{This controls whether messages for +deprecated functions in Shiny will be printed. See +\code{\link{shinyDeprecated}} for more information.} +\item{shiny.fullstacktrace}{Controls whether "pretty" or full stack traces +are dumped to the console when errors occur during Shiny app execution. +The default is \code{FALSE} (pretty stack traces).} +\item{shiny.stacktraceoffset}{If \code{TRUE}, then Shiny's printed stack +traces will display srcrefs one line above their usual location. This is +an arguably more intuitive arrangement for casual R users, as the name +of a function appears next to the srcref where it is defined, rather than +where it is currently being called from.} +\item{shiny.sanitize.errors}{If \code{TRUE}, then normal errors (i.e. +errors not wrapped in \code{safeError}) won't show up in the app; a simple +generic error message is printed instead (the error and strack trace printed +to the console remain unchanged). The default is \code{FALSE} (unsanitized +errors).If you want to sanitize errors in general, but you DO want a +particular error \code{e} to get displayed to the user, then set this option +to \code{TRUE} and use \code{stop(safeError(e))} for errors you want the +user to see.} +\item{shiny.testmode}{If \code{TRUE}, then enable features for testing Shiny +applications. If \code{FALSE} (the default), do not enable those features. +} } } diff --git a/man/shinyApp.Rd b/man/shinyApp.Rd index dd6cef03e..29ce097d1 100644 --- a/man/shinyApp.Rd +++ b/man/shinyApp.Rd @@ -73,7 +73,7 @@ file and either ui.R or www/index.html)} } \value{ An object that represents the app. Printing the object or passing it - to \code{\link{runApp}} will run the app. +to \code{\link{runApp}} will run the app. } \description{ These functions create Shiny app objects from either an explicit UI/server diff --git a/man/stacktrace.Rd b/man/stacktrace.Rd index 754718ab4..1eb524260 100644 --- a/man/stacktrace.Rd +++ b/man/stacktrace.Rd @@ -65,8 +65,8 @@ left alone (traditional R treatment where the srcref is of the callsite).} } \value{ \code{printError} and \code{printStackTrace} return - \code{invisible()}. The other functions pass through the results of - \code{expr}. +\code{invisible()}. The other functions pass through the results of +\code{expr}. } \description{ Advanced (borderline internal) functions for capturing, printing, and @@ -74,50 +74,50 @@ manipulating stack traces. } \details{ \code{captureStackTraces} runs the given \code{expr} and if any - \emph{uncaught} errors occur, annotates them with stack trace info for use - by \code{printError} and \code{printStackTrace}. It is not necessary to use - \code{captureStackTraces} around the same expression as - \code{withLogErrors}, as the latter includes a call to the former. Note - that if \code{expr} contains calls (either directly or indirectly) to - \code{try}, or \code{tryCatch} with an error handler, stack traces therein - cannot be captured unless another \code{captureStackTraces} call is - inserted in the interior of the \code{try} or \code{tryCatch}. This is - because these calls catch the error and prevent it from traveling up to the - condition handler installed by \code{captureStackTraces}. +\emph{uncaught} errors occur, annotates them with stack trace info for use +by \code{printError} and \code{printStackTrace}. It is not necessary to use +\code{captureStackTraces} around the same expression as +\code{withLogErrors}, as the latter includes a call to the former. Note +that if \code{expr} contains calls (either directly or indirectly) to +\code{try}, or \code{tryCatch} with an error handler, stack traces therein +cannot be captured unless another \code{captureStackTraces} call is +inserted in the interior of the \code{try} or \code{tryCatch}. This is +because these calls catch the error and prevent it from traveling up to the +condition handler installed by \code{captureStackTraces}. \code{withLogErrors} captures stack traces and logs errors that - occur in \code{expr}, but does allow errors to propagate beyond this point - (i.e. it doesn't catch the error). The same caveats that apply to - \code{captureStackTraces} with regard to \code{try}/\code{tryCatch} apply - to \code{withLogErrors}. +occur in \code{expr}, but does allow errors to propagate beyond this point +(i.e. it doesn't catch the error). The same caveats that apply to +\code{captureStackTraces} with regard to \code{try}/\code{tryCatch} apply +to \code{withLogErrors}. \code{printError} prints the error and stack trace (if any) using - \code{warning(immediate.=TRUE)}. \code{printStackTrace} prints the stack - trace only. +\code{warning(immediate.=TRUE)}. \code{printStackTrace} prints the stack +trace only. \code{extractStackTrace} takes a list of calls (e.g. as returned - from \code{conditionStackTrace(cond)}) and returns a data frame with one - row for each stack frame and the columns \code{num} (stack frame number), - \code{call} (a function name or similar), and \code{loc} (source file path - and line number, if available). It was deprecated after shiny 1.0.5 because - it doesn't support deep stack traces. +from \code{conditionStackTrace(cond)}) and returns a data frame with one +row for each stack frame and the columns \code{num} (stack frame number), +\code{call} (a function name or similar), and \code{loc} (source file path +and line number, if available). It was deprecated after shiny 1.0.5 because +it doesn't support deep stack traces. \code{formatStackTrace} is similar to \code{extractStackTrace}, but - it returns a preformatted character vector instead of a data frame. It was - deprecated after shiny 1.0.5 because it doesn't support deep stack traces. +it returns a preformatted character vector instead of a data frame. It was +deprecated after shiny 1.0.5 because it doesn't support deep stack traces. \code{conditionStackTrace} and \code{conditionStackTrace<-} are - accessor functions for getting/setting stack traces on conditions. +accessor functions for getting/setting stack traces on conditions. The two functions \code{..stacktraceon..} and - \code{..stacktraceoff..} have no runtime behavior during normal execution; - they exist only to create artifacts on the stack trace (sys.call()) that - instruct the stack trace pretty printer what parts of the stack trace are - interesting or not. The initial state is 1 and we walk from the outermost - call inwards. Each ..stacktraceoff.. decrements the state by one, and each - ..stacktraceon.. increments the state by one. Any stack trace frame whose - value is less than 1 is hidden, and finally, the ..stacktraceon.. and - ..stacktraceoff.. calls themselves are hidden too. +\code{..stacktraceoff..} have no runtime behavior during normal execution; +they exist only to create artifacts on the stack trace (sys.call()) that +instruct the stack trace pretty printer what parts of the stack trace are +interesting or not. The initial state is 1 and we walk from the outermost +call inwards. Each ..stacktraceoff.. decrements the state by one, and each +..stacktraceon.. increments the state by one. Any stack trace frame whose +value is less than 1 is hidden, and finally, the ..stacktraceon.. and +..stacktraceoff.. calls themselves are hidden too. } \examples{ # Keeps tryCatch and withVisible related calls off the diff --git a/man/tabsetPanel.Rd b/man/tabsetPanel.Rd index b64f160be..584dbf80c 100644 --- a/man/tabsetPanel.Rd +++ b/man/tabsetPanel.Rd @@ -45,5 +45,5 @@ mainPanel( } \seealso{ \code{\link{tabPanel}}, \code{\link{updateTabsetPanel}}, - \code{\link{insertTab}}, \code{\link{showTab}} +\code{\link{insertTab}}, \code{\link{showTab}} } diff --git a/man/textOutput.Rd b/man/textOutput.Rd index 0ae20a4db..1dcc21d44 100644 --- a/man/textOutput.Rd +++ b/man/textOutput.Rd @@ -24,7 +24,7 @@ text will be included within an HTML \code{div} tag by default. } \details{ Text is HTML-escaped prior to rendering. This element is often used - to display \link{renderText} output variables. +to display \link{renderText} output variables. } \examples{ h3(textOutput("caption")) diff --git a/man/titlePanel.Rd b/man/titlePanel.Rd index e1e2ea090..a023830c7 100644 --- a/man/titlePanel.Rd +++ b/man/titlePanel.Rd @@ -16,8 +16,8 @@ Create a panel containing an application title. } \details{ Calling this function has the side effect of including a - \code{title} tag within the head. You can also specify a page title - explicitly using the `title` parameter of the top-level page function. +\code{title} tag within the head. You can also specify a page title +explicitly using the \code{title} parameter of the top-level page function. } \examples{ ## Only run examples in interactive R sessions diff --git a/man/updateQueryString.Rd b/man/updateQueryString.Rd index d63c1d7c0..3989c0aa9 100644 --- a/man/updateQueryString.Rd +++ b/man/updateQueryString.Rd @@ -26,10 +26,10 @@ Internet Explorer 9 and below. \details{ For \code{mode = "push"}, only three updates are currently allowed: \enumerate{ - \item the query string (format: \code{?param1=val1¶m2=val2}) - \item the hash (format: \code{#hash}) - \item both the query string and the hash - (format: \code{?param1=val1¶m2=val2#hash}) +\item the query string (format: \code{?param1=val1¶m2=val2}) +\item the hash (format: \code{#hash}) +\item both the query string and the hash +(format: \code{?param1=val1¶m2=val2#hash}) } In other words, if \code{mode = "push"}, the \code{queryString} must start diff --git a/man/validate.Rd b/man/validate.Rd index 1c9cc205b..8500f52b9 100644 --- a/man/validate.Rd +++ b/man/validate.Rd @@ -48,14 +48,14 @@ considered a failure, then the string will be used as the error message. The the following: \itemize{ - \item{\code{FALSE}} - \item{\code{NULL}} - \item{\code{""}} - \item{An empty atomic vector} - \item{An atomic vector that contains only missing values} - \item{A logical vector that contains all \code{FALSE} or missing values} - \item{An object of class \code{"try-error"}} - \item{A value that represents an unclicked \code{\link{actionButton}}} +\item{\code{FALSE}} +\item{\code{NULL}} +\item{\code{""}} +\item{An empty atomic vector} +\item{An atomic vector that contains only missing values} +\item{A logical vector that contains all \code{FALSE} or missing values} +\item{An object of class \code{"try-error"}} +\item{A value that represents an unclicked \code{\link{actionButton}}} } If any of these values happen to be valid, you can explicitly turn them to diff --git a/man/varSelectInput.Rd b/man/varSelectInput.Rd index b8baa9d50..6b25c0714 100644 --- a/man/varSelectInput.Rd +++ b/man/varSelectInput.Rd @@ -50,14 +50,14 @@ from the column names of a data frame. \details{ The resulting server \code{input} value will be returned as: \itemize{ - \item a symbol if \code{multiple = FALSE}. The \code{input} value should be - used with rlang's \code{\link[rlang]{!!}}. For example, - \code{ggplot2::aes(!!input$variable)}. - \item a list of symbols if \code{multiple = TRUE}. The \code{input} value - should be used with rlang's \code{\link[rlang]{!!!}} to expand - the symbol list as individual arguments. For example, - \code{dplyr::select(mtcars, !!!input$variabls)} which is - equivalent to \code{dplyr::select(mtcars, !!input$variabls[[1]], !!input$variabls[[2]], ..., !!input$variabls[[length(input$variabls)]])}. +\item a symbol if \code{multiple = FALSE}. The \code{input} value should be +used with rlang's \code{\link[rlang]{!!}}. For example, +\code{ggplot2::aes(!!input$variable)}. +\item a list of symbols if \code{multiple = TRUE}. The \code{input} value +should be used with rlang's \code{\link[rlang]{!!!}} to expand +the symbol list as individual arguments. For example, +\code{dplyr::select(mtcars, !!!input$variabls)} which is +equivalent to \code{dplyr::select(mtcars, !!input$variabls[[1]], !!input$variabls[[2]], ..., !!input$variabls[[length(input$variabls)]])}. } By default, \code{varSelectInput()} and \code{selectizeInput()} use the @@ -68,13 +68,13 @@ select input element. To use the standard HTML select input element, use } \note{ The variable selectize input created from \code{varSelectizeInput()} allows - deletion of the selected option even in a single select input, which will - return an empty string as its value. This is the default behavior of - \pkg{selectize.js}. However, the selectize input created from - \code{selectInput(..., selectize = TRUE)} will ignore the empty string - value when it is a single choice input and the empty string is not in the - \code{choices} argument. This is to keep compatibility with - \code{selectInput(..., selectize = FALSE)}. +deletion of the selected option even in a single select input, which will +return an empty string as its value. This is the default behavior of +\pkg{selectize.js}. However, the selectize input created from +\code{selectInput(..., selectize = TRUE)} will ignore the empty string +value when it is a single choice input and the empty string is not in the +\code{choices} argument. This is to keep compatibility with +\code{selectInput(..., selectize = FALSE)}. } \examples{ diff --git a/man/verbatimTextOutput.Rd b/man/verbatimTextOutput.Rd index 67c2c2f50..b83c8ed90 100644 --- a/man/verbatimTextOutput.Rd +++ b/man/verbatimTextOutput.Rd @@ -22,8 +22,8 @@ application page. The text will be included within an HTML \code{pre} tag. } \details{ Text is HTML-escaped prior to rendering. This element is often used - with the \link{renderPrint} function to preserve fixed-width formatting - of printed objects. +with the \link{renderPrint} function to preserve fixed-width formatting +of printed objects. } \examples{ ## Only run this example in interactive R sessions diff --git a/man/viewer.Rd b/man/viewer.Rd index 48fa9981c..1fa20e796 100644 --- a/man/viewer.Rd +++ b/man/viewer.Rd @@ -27,7 +27,7 @@ size. If \code{"maximize"}, use the maximum available vertical space.} } \value{ A function that takes a single \code{url} parameter, suitable for - passing as the \code{viewer} argument of \code{\link{runGadget}}. +passing as the \code{viewer} argument of \code{\link{runGadget}}. } \description{ Use these functions to control where the gadget is displayed in RStudio (or