From dde266768c9a96f2dcb260df8f360aaef341506f Mon Sep 17 00:00:00 2001 From: Joe Cheng Date: Thu, 29 May 2014 14:00:48 -0700 Subject: [PATCH] Restore HTML generating functions These functions were temporarily ripped out of Shiny and moved to the htmltools package. We've discovered that it's safe to keep including them in shiny; as long as the functions in shiny and the functions in htmltools are identical, the user won't receive a conflict warning. --- .Rbuildignore | 1 + DESCRIPTION | 10 ++-- NAMESPACE | 36 +++++++++++- R/htmltools.R | 101 ++++++++++++++++++++++++++++++++ R/shinywrappers.R | 2 +- inst/staticdocs/index.r | 15 ++++- inst/tests/test-staticdocs.R | 2 +- man/HTML.Rd | 24 ++++++++ man/absolutePanel.Rd | 2 +- man/actionButton.Rd | 2 +- man/addResourcePath.Rd | 2 +- man/bootstrapPage.Rd | 2 +- man/builder.Rd | 96 ++++++++++++++++++++++++++++++ man/checkboxGroupInput.Rd | 2 +- man/checkboxInput.Rd | 2 +- man/column.Rd | 2 +- man/conditionalPanel.Rd | 2 +- man/dateInput.Rd | 2 +- man/dateRangeInput.Rd | 2 +- man/domains.Rd | 2 +- man/downloadButton.Rd | 2 +- man/downloadHandler.Rd | 2 +- man/exprToFunction.Rd | 2 +- man/fileInput.Rd | 2 +- man/fixedPage.Rd | 2 +- man/flowLayout.Rd | 2 +- man/fluidPage.Rd | 2 +- man/headerPanel.Rd | 2 +- man/helpText.Rd | 2 +- man/htmlOutput.Rd | 2 +- man/icon.Rd | 2 +- man/imageOutput.Rd | 2 +- man/include.Rd | 45 ++++++++++++++ man/inputPanel.Rd | 2 +- man/installExprFunction.Rd | 2 +- man/invalidateLater.Rd | 2 +- man/is.reactivevalues.Rd | 2 +- man/isolate.Rd | 2 +- man/knitr_methods.Rd | 2 +- man/mainPanel.Rd | 2 +- man/makeReactiveBinding.Rd | 2 +- man/markRenderFunction.Rd | 2 +- man/maskReactiveContext.Rd | 2 +- man/navbarPage.Rd | 2 +- man/navlistPanel.Rd | 2 +- man/numericInput.Rd | 2 +- man/observe.Rd | 2 +- man/outputOptions.Rd | 2 +- man/pageWithSidebar.Rd | 2 +- man/parseQueryString.Rd | 2 +- man/plotOutput.Rd | 2 +- man/plotPNG.Rd | 2 +- man/radioButtons.Rd | 2 +- man/reactive.Rd | 2 +- man/reactiveFileReader.Rd | 2 +- man/reactivePlot.Rd | 2 +- man/reactivePoll.Rd | 2 +- man/reactivePrint.Rd | 2 +- man/reactiveTable.Rd | 2 +- man/reactiveText.Rd | 2 +- man/reactiveTimer.Rd | 2 +- man/reactiveUI.Rd | 2 +- man/reactiveValues.Rd | 2 +- man/reactiveValuesToList.Rd | 2 +- man/registerInputHandler.Rd | 2 +- man/removeInputHandler.Rd | 2 +- man/renderDataTable.Rd | 2 +- man/renderImage.Rd | 2 +- man/renderPlot.Rd | 2 +- man/renderPrint.Rd | 2 +- man/renderTable.Rd | 2 +- man/renderText.Rd | 2 +- man/renderUI.Rd | 2 +- man/repeatable.Rd | 2 +- man/runApp.Rd | 2 +- man/runExample.Rd | 2 +- man/runGist.Rd | 2 +- man/runGitHub.Rd | 2 +- man/runUrl.Rd | 2 +- man/selectInput.Rd | 2 +- man/session.Rd | 2 +- man/shiny-package.Rd | 2 +- man/shinyApp.Rd | 2 +- man/shinyDeprecated.Rd | 2 +- man/shinyServer.Rd | 2 +- man/shinyUI.Rd | 2 +- man/showReactLog.Rd | 2 +- man/sidebarLayout.Rd | 2 +- man/sidebarPanel.Rd | 2 +- man/singleton.Rd | 21 +++++++ man/sliderInput.Rd | 2 +- man/splitLayout.Rd | 2 +- man/stopApp.Rd | 2 +- man/submitButton.Rd | 2 +- man/tabPanel.Rd | 2 +- man/tableOutput.Rd | 2 +- man/tabsetPanel.Rd | 2 +- man/tag.Rd | 64 ++++++++++++++++++++ man/textInput.Rd | 2 +- man/textOutput.Rd | 2 +- man/titlePanel.Rd | 2 +- man/updateCheckboxGroupInput.Rd | 2 +- man/updateCheckboxInput.Rd | 2 +- man/updateDateInput.Rd | 2 +- man/updateDateRangeInput.Rd | 2 +- man/updateNumericInput.Rd | 2 +- man/updateRadioButtons.Rd | 2 +- man/updateSelectInput.Rd | 2 +- man/updateSliderInput.Rd | 2 +- man/updateTabsetPanel.Rd | 2 +- man/updateTextInput.Rd | 2 +- man/validate.Rd | 2 +- man/validateCssUnit.Rd | 36 ++++++++++++ man/verbatimTextOutput.Rd | 2 +- man/verticalLayout.Rd | 2 +- man/wellPanel.Rd | 2 +- man/withMathJax.Rd | 2 +- man/withTags.Rd | 38 ++++++++++++ tools/importdocs.sh | 15 +++++ 119 files changed, 601 insertions(+), 113 deletions(-) create mode 100644 R/htmltools.R create mode 100644 man/HTML.Rd create mode 100644 man/builder.Rd create mode 100644 man/include.Rd create mode 100644 man/singleton.Rd create mode 100644 man/tag.Rd create mode 100644 man/validateCssUnit.Rd create mode 100644 man/withTags.Rd create mode 100755 tools/importdocs.sh diff --git a/.Rbuildignore b/.Rbuildignore index 9a1ee7f03..f2f6d41e9 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -10,3 +10,4 @@ ^man-roxygen$ ^\.travis\.yml$ ^staticdocs$ +^tools$ diff --git a/DESCRIPTION b/DESCRIPTION index 64751ebde..675eb0e32 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -12,8 +12,7 @@ Description: Shiny makes it incredibly easy to build interactive web License: GPL-3 Depends: R (>= 2.14.1), - methods, - htmltools (>= 0.2.4) + methods Imports: tools, utils, @@ -21,12 +20,14 @@ Imports: caTools, RJSONIO, xtable, - digest + digest, + htmltools (>= 0.2.4) Suggests: datasets, Cairo (>= 1.5-5), testthat, - knitr + knitr (>= 1.6), + markdown URL: http://www.rstudio.com/shiny/ BugReports: https://github.com/rstudio/shiny/issues Roxygen: list(wrap = FALSE) @@ -42,6 +43,7 @@ Collate: 'graph.R' 'hooks.R' 'html-deps.R' + 'htmltools.R' 'imageutils.R' 'jqueryui.R' 'middleware-shiny.R' diff --git a/NAMESPACE b/NAMESPACE index f78f1e8e3..1df7f6ef9 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,4 @@ -# Generated by roxygen2 (4.0.0): do not edit by hand +# Generated by roxygen2 (4.0.1): do not edit by hand S3method("$",reactivevalues) S3method("$",shinyoutput) @@ -22,6 +22,8 @@ S3method(names,reactivevalues) S3method(print,reactive) S3method(print,shiny.appobj) S3method(str,reactivevalues) +export(HTML) +export(a) export(absolutePanel) export(actionButton) export(actionLink) @@ -30,16 +32,20 @@ export(animationOptions) export(as.shiny.appobj) export(basicPage) export(bootstrapPage) +export(br) export(checkboxGroupInput) export(checkboxInput) +export(code) export(column) export(conditionalPanel) export(dataTableOutput) export(dateInput) export(dateRangeInput) +export(div) export(downloadButton) export(downloadHandler) export(downloadLink) +export(em) export(exprToFunction) export(fileInput) export(fixedPage) @@ -49,16 +55,30 @@ export(flowLayout) export(fluidPage) export(fluidRow) export(getDefaultReactiveDomain) +export(h1) +export(h2) +export(h3) +export(h4) +export(h5) +export(h6) export(headerPanel) export(helpText) +export(hr) export(htmlOutput) export(icon) export(imageOutput) +export(img) +export(includeCSS) +export(includeHTML) +export(includeMarkdown) +export(includeScript) +export(includeText) export(inputPanel) export(installExprFunction) export(invalidateLater) export(is.reactive) export(is.reactivevalues) +export(is.singleton) export(isolate) export(knit_print.shiny.appobj) export(knit_print.shiny.render.function) @@ -74,10 +94,12 @@ export(numericInput) export(observe) export(onReactiveDomainEnded) export(outputOptions) +export(p) export(pageWithSidebar) export(parseQueryString) export(plotOutput) export(plotPNG) +export(pre) export(radioButtons) export(reactive) export(reactiveFileReader) @@ -114,13 +136,23 @@ export(shinyUI) export(showReactLog) export(sidebarLayout) export(sidebarPanel) +export(singleton) export(sliderInput) +export(span) export(splitLayout) export(stopApp) +export(strong) export(submitButton) export(tabPanel) export(tableOutput) export(tabsetPanel) +export(tag) +export(tagAppendAttributes) +export(tagAppendChild) +export(tagAppendChildren) +export(tagList) +export(tagSetChildren) +export(tags) export(textInput) export(textOutput) export(titlePanel) @@ -137,11 +169,13 @@ export(updateSliderInput) export(updateTabsetPanel) export(updateTextInput) export(validate) +export(validateCssUnit) export(verbatimTextOutput) export(verticalLayout) export(wellPanel) export(withMathJax) export(withReactiveDomain) +export(withTags) import(RJSONIO) import(caTools) import(digest) diff --git a/R/htmltools.R b/R/htmltools.R new file mode 100644 index 000000000..d48e43189 --- /dev/null +++ b/R/htmltools.R @@ -0,0 +1,101 @@ +#' @export +a <- htmltools::a + +#' @export +br <- htmltools::br + +#' @export +code <- htmltools::code + +#' @export +div <- htmltools::div + +#' @export +em <- htmltools::em + +#' @export +h1 <- htmltools::h1 + +#' @export +h2 <- htmltools::h2 + +#' @export +h3 <- htmltools::h3 + +#' @export +h4 <- htmltools::h4 + +#' @export +h5 <- htmltools::h5 + +#' @export +h6 <- htmltools::h6 + +#' @export +hr <- htmltools::hr + +#' @export +HTML <- htmltools::HTML + +#' @export +img <- htmltools::img + +#' @export +includeCSS <- htmltools::includeCSS + +#' @export +includeHTML <- htmltools::includeHTML + +#' @export +includeMarkdown <- htmltools::includeMarkdown + +#' @export +includeScript <- htmltools::includeScript + +#' @export +includeText <- htmltools::includeText + +#' @export +is.singleton <- htmltools::is.singleton + +#' @export +p <- htmltools::p + +#' @export +pre <- htmltools::pre + +#' @export +singleton <- htmltools::singleton + +#' @export +span <- htmltools::span + +#' @export +strong <- htmltools::strong + +#' @export +tag <- htmltools::tag + +#' @export +tagAppendAttributes <- htmltools::tagAppendAttributes + +#' @export +tagAppendChild <- htmltools::tagAppendChild + +#' @export +tagAppendChildren <- htmltools::tagAppendChildren + +#' @export +tagList <- htmltools::tagList + +#' @export +tags <- htmltools::tags + +#' @export +tagSetChildren <- htmltools::tagSetChildren + +#' @export +validateCssUnit <- htmltools::validateCssUnit + +#' @export +withTags <- htmltools::withTags diff --git a/R/shinywrappers.R b/R/shinywrappers.R index d779d8885..f7cf72092 100644 --- a/R/shinywrappers.R +++ b/R/shinywrappers.R @@ -30,7 +30,7 @@ useRenderFunction <- function(renderFunc) { return(outputFunction(id)) } -#' @export +#' @S3method as.tags shiny.render.function as.tags.shiny.render.function <- function(x, ...) { useRenderFunction(x) } diff --git a/inst/staticdocs/index.r b/inst/staticdocs/index.r index 523007cd1..4f0e255e3 100644 --- a/inst/staticdocs/index.r +++ b/inst/staticdocs/index.r @@ -67,6 +67,18 @@ sd_section("UI Outputs", "downloadButton" ) ) +sd_section("Interface builder functions", + "A sub-library for writing HTML using R functions. These functions form the foundation on which the higher level user interface functions are built, and can also be used in your Shiny UI to provide custom HTML, CSS, and JavaScript.", + c( + "builder", + "HTML", + "include", + "singleton", + "tag", + "validateCssUnit", + "withTags" + ) +) sd_section("Rendering functions", "Functions that you use in your application's server side code, assigning them to outputs that appear in your user interface.", c( @@ -147,7 +159,6 @@ sd_section("Embedding", "Functions that are intended for third-party packages that embed Shiny applications.", c( "shinyApp", - "maskReactiveContext", - "knitr_methods" + "maskReactiveContext" ) ) diff --git a/inst/tests/test-staticdocs.R b/inst/tests/test-staticdocs.R index 18306326a..1495505e4 100644 --- a/inst/tests/test-staticdocs.R +++ b/inst/tests/test-staticdocs.R @@ -6,7 +6,7 @@ test_that("All man pages have an entry in staticdocs/index.r", { return() } # Known not to be indexed - known_unindexed <- c("shiny-package") + known_unindexed <- c("shiny-package", "knitr_methods") indexed_topics <- local({ result <- character(0) diff --git a/man/HTML.Rd b/man/HTML.Rd new file mode 100644 index 000000000..705909e15 --- /dev/null +++ b/man/HTML.Rd @@ -0,0 +1,24 @@ +\name{HTML} +\alias{HTML} +\title{Mark Characters as HTML} +\usage{ +HTML(text, ...) +} +\arguments{ +\item{text}{The text value to mark with HTML} + +\item{...}{Any additional values to be converted to character and +concatenated together} +} +\value{ +The same value, but marked as HTML. +} +\description{ +Marks the given text as HTML, which means the \link{tag} functions will know +not to perform HTML escaping on it. +} +\examples{ +el <- div(HTML("I like turtles")) +cat(as.character(el)) +} + diff --git a/man/absolutePanel.Rd b/man/absolutePanel.Rd index 610adb113..d12f43894 100644 --- a/man/absolutePanel.Rd +++ b/man/absolutePanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{absolutePanel} \alias{absolutePanel} \alias{fixedPanel} diff --git a/man/actionButton.Rd b/man/actionButton.Rd index e601627b1..a1802e274 100644 --- a/man/actionButton.Rd +++ b/man/actionButton.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{actionButton} \alias{actionButton} \alias{actionLink} diff --git a/man/addResourcePath.Rd b/man/addResourcePath.Rd index 1e7189ba2..854590379 100644 --- a/man/addResourcePath.Rd +++ b/man/addResourcePath.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{addResourcePath} \alias{addResourcePath} \title{Resource Publishing} diff --git a/man/bootstrapPage.Rd b/man/bootstrapPage.Rd index 810166cd3..d148df4d7 100644 --- a/man/bootstrapPage.Rd +++ b/man/bootstrapPage.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{bootstrapPage} \alias{basicPage} \alias{bootstrapPage} diff --git a/man/builder.Rd b/man/builder.Rd new file mode 100644 index 000000000..712cb21d8 --- /dev/null +++ b/man/builder.Rd @@ -0,0 +1,96 @@ +\name{builder} +\alias{a} +\alias{br} +\alias{builder} +\alias{code} +\alias{div} +\alias{em} +\alias{h1} +\alias{h2} +\alias{h3} +\alias{h4} +\alias{h5} +\alias{h6} +\alias{hr} +\alias{img} +\alias{p} +\alias{pre} +\alias{span} +\alias{strong} +\alias{tags} +\title{HTML Builder Functions} +\usage{ +tags + +p(...) + +h1(...) + +h2(...) + +h3(...) + +h4(...) + +h5(...) + +h6(...) + +a(...) + +br(...) + +div(...) + +span(...) + +pre(...) + +code(...) + +img(...) + +strong(...) + +em(...) + +hr(...) +} +\arguments{ +\item{...}{Attributes and children of the element. Named arguments become +attributes, and positional arguments become children. Valid children are +tags, single-character character vectors (which become text nodes), and raw +HTML (see \code{\link{HTML}}). You can also pass lists that contain tags, +text nodes, and HTML.} +} +\description{ +Simple functions for constructing HTML documents. +} +\details{ +The \code{tags} environment contains convenience functions for all valid +HTML5 tags. To generate tags that are not part of the HTML5 specification, +you can use the \code{\link{tag}()} function. + +Dedicated functions are available for the most common HTML tags that do not +conflict with common R functions. + +The result from these functions is a tag object, which can be converted using +\code{\link{as.character}()}. +} +\examples{ +doc <- tags$html( + tags$head( + tags$title('My first page') + ), + tags$body( + h1('My first heading'), + p('My first paragraph, with some ', + strong('bold'), + ' text.'), + div(id='myDiv', class='simpleDiv', + 'Here is a div with some attributes.') + ) +) +cat(as.character(doc)) +} + diff --git a/man/checkboxGroupInput.Rd b/man/checkboxGroupInput.Rd index ef7604d1d..aad227d72 100644 --- a/man/checkboxGroupInput.Rd +++ b/man/checkboxGroupInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{checkboxGroupInput} \alias{checkboxGroupInput} \title{Checkbox Group Input Control} diff --git a/man/checkboxInput.Rd b/man/checkboxInput.Rd index 122be61da..5f2f681d4 100644 --- a/man/checkboxInput.Rd +++ b/man/checkboxInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{checkboxInput} \alias{checkboxInput} \title{Checkbox Input Control} diff --git a/man/column.Rd b/man/column.Rd index d97f7c918..279b635ff 100644 --- a/man/column.Rd +++ b/man/column.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{column} \alias{column} \title{Create a column within a UI definition} diff --git a/man/conditionalPanel.Rd b/man/conditionalPanel.Rd index c7a2a3b9c..610535cb3 100644 --- a/man/conditionalPanel.Rd +++ b/man/conditionalPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{conditionalPanel} \alias{conditionalPanel} \title{Conditional Panel} diff --git a/man/dateInput.Rd b/man/dateInput.Rd index 278a04822..dd0ab08d0 100644 --- a/man/dateInput.Rd +++ b/man/dateInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{dateInput} \alias{dateInput} \title{Create date input} diff --git a/man/dateRangeInput.Rd b/man/dateRangeInput.Rd index 19f64865f..cbe209db3 100644 --- a/man/dateRangeInput.Rd +++ b/man/dateRangeInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{dateRangeInput} \alias{dateRangeInput} \title{Create date range input} diff --git a/man/domains.Rd b/man/domains.Rd index 213cf1a25..327153daf 100644 --- a/man/domains.Rd +++ b/man/domains.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{getDefaultReactiveDomain} \alias{domains} \alias{getDefaultReactiveDomain} diff --git a/man/downloadButton.Rd b/man/downloadButton.Rd index 8969f4efd..50dbdda98 100644 --- a/man/downloadButton.Rd +++ b/man/downloadButton.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{downloadButton} \alias{downloadButton} \alias{downloadLink} diff --git a/man/downloadHandler.Rd b/man/downloadHandler.Rd index ed8ea136f..b422c32cc 100644 --- a/man/downloadHandler.Rd +++ b/man/downloadHandler.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{downloadHandler} \alias{downloadHandler} \title{File Downloads} diff --git a/man/exprToFunction.Rd b/man/exprToFunction.Rd index 459c4e403..01e0fbd2f 100644 --- a/man/exprToFunction.Rd +++ b/man/exprToFunction.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{exprToFunction} \alias{exprToFunction} \title{Convert an expression to a function} diff --git a/man/fileInput.Rd b/man/fileInput.Rd index d462b797a..0980ab058 100644 --- a/man/fileInput.Rd +++ b/man/fileInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{fileInput} \alias{fileInput} \title{File Upload Control} diff --git a/man/fixedPage.Rd b/man/fixedPage.Rd index ece6d6b68..3820e25cb 100644 --- a/man/fixedPage.Rd +++ b/man/fixedPage.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{fixedPage} \alias{fixedPage} \alias{fixedRow} diff --git a/man/flowLayout.Rd b/man/flowLayout.Rd index b35f7a1a9..d412a7edf 100644 --- a/man/flowLayout.Rd +++ b/man/flowLayout.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{flowLayout} \alias{flowLayout} \title{Flow layout} diff --git a/man/fluidPage.Rd b/man/fluidPage.Rd index 2ba35e5ba..155d333bb 100644 --- a/man/fluidPage.Rd +++ b/man/fluidPage.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{fluidPage} \alias{fluidPage} \alias{fluidRow} diff --git a/man/headerPanel.Rd b/man/headerPanel.Rd index 640bb7e89..39ac3c15e 100644 --- a/man/headerPanel.Rd +++ b/man/headerPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{headerPanel} \alias{headerPanel} \title{Create a header panel} diff --git a/man/helpText.Rd b/man/helpText.Rd index 664c48714..f76ee792f 100644 --- a/man/helpText.Rd +++ b/man/helpText.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{helpText} \alias{helpText} \title{Create a help text element} diff --git a/man/htmlOutput.Rd b/man/htmlOutput.Rd index bca43eca7..1294899d1 100644 --- a/man/htmlOutput.Rd +++ b/man/htmlOutput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{htmlOutput} \alias{htmlOutput} \alias{uiOutput} diff --git a/man/icon.Rd b/man/icon.Rd index 212aa9b28..e43050d5d 100644 --- a/man/icon.Rd +++ b/man/icon.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{icon} \alias{icon} \title{Create an icon} diff --git a/man/imageOutput.Rd b/man/imageOutput.Rd index 06b68e14e..f72f3f57b 100644 --- a/man/imageOutput.Rd +++ b/man/imageOutput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{imageOutput} \alias{imageOutput} \title{Create a image output element} diff --git a/man/include.Rd b/man/include.Rd new file mode 100644 index 000000000..318a155ca --- /dev/null +++ b/man/include.Rd @@ -0,0 +1,45 @@ +\name{include} +\alias{include} +\alias{includeCSS} +\alias{includeHTML} +\alias{includeMarkdown} +\alias{includeScript} +\alias{includeText} +\title{Include Content From a File} +\usage{ +includeHTML(path) + +includeText(path) + +includeMarkdown(path) + +includeCSS(path, ...) + +includeScript(path, ...) +} +\arguments{ +\item{path}{The path of the file to be included. It is highly recommended to + use a relative path (the base path being the Shiny application directory), + not an absolute path.} + +\item{...}{Any additional attributes to be applied to the generated tag.} +} +\description{ +Load HTML, text, or rendered Markdown from a file and turn into HTML. +} +\details{ +These functions provide a convenient way to include an extensive amount of +HTML, textual, Markdown, CSS, or JavaScript content, rather than using a +large literal R string. +} +\note{ +\code{includeText} escapes its contents, but does no other processing. + This means that hard breaks and multiple spaces will be rendered as they + usually are in HTML: as a single space character. If you are looking for + preformatted text, wrap the call with \code{\link{pre}}, or consider using + \code{includeMarkdown} instead. + +The \code{includeMarkdown} function requires the \code{markdown} + package. +} + diff --git a/man/inputPanel.Rd b/man/inputPanel.Rd index 21f6f5b20..b9ff8feb4 100644 --- a/man/inputPanel.Rd +++ b/man/inputPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{inputPanel} \alias{inputPanel} \title{Input panel} diff --git a/man/installExprFunction.Rd b/man/installExprFunction.Rd index 828ea642a..40ec704a1 100644 --- a/man/installExprFunction.Rd +++ b/man/installExprFunction.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{installExprFunction} \alias{installExprFunction} \title{Install an expression as a function} diff --git a/man/invalidateLater.Rd b/man/invalidateLater.Rd index 6de7bbb6c..bdd895961 100644 --- a/man/invalidateLater.Rd +++ b/man/invalidateLater.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{invalidateLater} \alias{invalidateLater} \title{Scheduled Invalidation} diff --git a/man/is.reactivevalues.Rd b/man/is.reactivevalues.Rd index 156538554..b75990611 100644 --- a/man/is.reactivevalues.Rd +++ b/man/is.reactivevalues.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{is.reactivevalues} \alias{is.reactivevalues} \title{Checks whether an object is a reactivevalues object} diff --git a/man/isolate.Rd b/man/isolate.Rd index 4a2e4b027..f24aab39b 100644 --- a/man/isolate.Rd +++ b/man/isolate.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{isolate} \alias{isolate} \title{Create a non-reactive scope for an expression} diff --git a/man/knitr_methods.Rd b/man/knitr_methods.Rd index 7d5f5fc8a..e1b84ebab 100644 --- a/man/knitr_methods.Rd +++ b/man/knitr_methods.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{knitr_methods} \alias{knit_print.shiny.appobj} \alias{knit_print.shiny.render.function} diff --git a/man/mainPanel.Rd b/man/mainPanel.Rd index d2cceb402..ea26dd2bd 100644 --- a/man/mainPanel.Rd +++ b/man/mainPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{mainPanel} \alias{mainPanel} \title{Create a main panel} diff --git a/man/makeReactiveBinding.Rd b/man/makeReactiveBinding.Rd index 44bafc940..9aac8369f 100644 --- a/man/makeReactiveBinding.Rd +++ b/man/makeReactiveBinding.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{makeReactiveBinding} \alias{makeReactiveBinding} \title{Make a reactive variable} diff --git a/man/markRenderFunction.Rd b/man/markRenderFunction.Rd index 444dcac56..1e2a99244 100644 --- a/man/markRenderFunction.Rd +++ b/man/markRenderFunction.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{markRenderFunction} \alias{markRenderFunction} \title{Mark a function as a render function} diff --git a/man/maskReactiveContext.Rd b/man/maskReactiveContext.Rd index df1c14ae5..a629e641c 100644 --- a/man/maskReactiveContext.Rd +++ b/man/maskReactiveContext.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{maskReactiveContext} \alias{maskReactiveContext} \title{Evaluate an expression without a reactive context} diff --git a/man/navbarPage.Rd b/man/navbarPage.Rd index bbab55873..d8b65a6ce 100644 --- a/man/navbarPage.Rd +++ b/man/navbarPage.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{navbarPage} \alias{navbarMenu} \alias{navbarPage} diff --git a/man/navlistPanel.Rd b/man/navlistPanel.Rd index dc9955804..7acf30133 100644 --- a/man/navlistPanel.Rd +++ b/man/navlistPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{navlistPanel} \alias{navlistPanel} \title{Create a navigation list panel} diff --git a/man/numericInput.Rd b/man/numericInput.Rd index ddc2b6083..d8d777aee 100644 --- a/man/numericInput.Rd +++ b/man/numericInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{numericInput} \alias{numericInput} \title{Create a numeric input control} diff --git a/man/observe.Rd b/man/observe.Rd index 02e7ed591..0dd61b8b1 100644 --- a/man/observe.Rd +++ b/man/observe.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{observe} \alias{observe} \title{Create a reactive observer} diff --git a/man/outputOptions.Rd b/man/outputOptions.Rd index fd76b3f6b..7a1944db9 100644 --- a/man/outputOptions.Rd +++ b/man/outputOptions.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{outputOptions} \alias{outputOptions} \title{Set options for an output object.} diff --git a/man/pageWithSidebar.Rd b/man/pageWithSidebar.Rd index 34c7a6e40..494169f8e 100644 --- a/man/pageWithSidebar.Rd +++ b/man/pageWithSidebar.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{pageWithSidebar} \alias{pageWithSidebar} \title{Create a page with a sidebar} diff --git a/man/parseQueryString.Rd b/man/parseQueryString.Rd index 27b8ed5dc..48d589635 100644 --- a/man/parseQueryString.Rd +++ b/man/parseQueryString.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{parseQueryString} \alias{parseQueryString} \title{Parse a GET query string from a URL} diff --git a/man/plotOutput.Rd b/man/plotOutput.Rd index a4f0bb0ab..dab9c50c2 100644 --- a/man/plotOutput.Rd +++ b/man/plotOutput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{plotOutput} \alias{plotOutput} \title{Create an plot output element} diff --git a/man/plotPNG.Rd b/man/plotPNG.Rd index e1d888689..7b0e8641e 100644 --- a/man/plotPNG.Rd +++ b/man/plotPNG.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{plotPNG} \alias{plotPNG} \title{Run a plotting function and save the output as a PNG} diff --git a/man/radioButtons.Rd b/man/radioButtons.Rd index 4be33d7c6..bf572d917 100644 --- a/man/radioButtons.Rd +++ b/man/radioButtons.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{radioButtons} \alias{radioButtons} \title{Create radio buttons} diff --git a/man/reactive.Rd b/man/reactive.Rd index c928bd9a9..3247c00de 100644 --- a/man/reactive.Rd +++ b/man/reactive.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactive} \alias{is.reactive} \alias{reactive} diff --git a/man/reactiveFileReader.Rd b/man/reactiveFileReader.Rd index c6e472d2e..a03afe8c5 100644 --- a/man/reactiveFileReader.Rd +++ b/man/reactiveFileReader.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveFileReader} \alias{reactiveFileReader} \title{Reactive file reader} diff --git a/man/reactivePlot.Rd b/man/reactivePlot.Rd index 3f26c39c4..e36317eab 100644 --- a/man/reactivePlot.Rd +++ b/man/reactivePlot.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactivePlot} \alias{reactivePlot} \title{Plot output (deprecated)} diff --git a/man/reactivePoll.Rd b/man/reactivePoll.Rd index f0fe6c2a1..13cd5cb22 100644 --- a/man/reactivePoll.Rd +++ b/man/reactivePoll.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactivePoll} \alias{reactivePoll} \title{Reactive polling} diff --git a/man/reactivePrint.Rd b/man/reactivePrint.Rd index f5007d4da..8a1f60dd7 100644 --- a/man/reactivePrint.Rd +++ b/man/reactivePrint.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactivePrint} \alias{reactivePrint} \title{Print output (deprecated)} diff --git a/man/reactiveTable.Rd b/man/reactiveTable.Rd index 23b4c5106..4c75b99c8 100644 --- a/man/reactiveTable.Rd +++ b/man/reactiveTable.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveTable} \alias{reactiveTable} \title{Table output (deprecated)} diff --git a/man/reactiveText.Rd b/man/reactiveText.Rd index 3c278eb08..5d78f7c6f 100644 --- a/man/reactiveText.Rd +++ b/man/reactiveText.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveText} \alias{reactiveText} \title{Text output (deprecated)} diff --git a/man/reactiveTimer.Rd b/man/reactiveTimer.Rd index db8528f0e..e7f31bf4a 100644 --- a/man/reactiveTimer.Rd +++ b/man/reactiveTimer.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveTimer} \alias{reactiveTimer} \title{Timer} diff --git a/man/reactiveUI.Rd b/man/reactiveUI.Rd index e33bb4f10..ee0f63afd 100644 --- a/man/reactiveUI.Rd +++ b/man/reactiveUI.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveUI} \alias{reactiveUI} \title{UI output (deprecated)} diff --git a/man/reactiveValues.Rd b/man/reactiveValues.Rd index a7422b05d..ba4ad2354 100644 --- a/man/reactiveValues.Rd +++ b/man/reactiveValues.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveValues} \alias{reactiveValues} \title{Create an object for storing reactive values} diff --git a/man/reactiveValuesToList.Rd b/man/reactiveValuesToList.Rd index 97d110856..4323b3c80 100644 --- a/man/reactiveValuesToList.Rd +++ b/man/reactiveValuesToList.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{reactiveValuesToList} \alias{reactiveValuesToList} \title{Convert a reactivevalues object to a list} diff --git a/man/registerInputHandler.Rd b/man/registerInputHandler.Rd index 3687b6a06..62ff8bd37 100644 --- a/man/registerInputHandler.Rd +++ b/man/registerInputHandler.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{registerInputHandler} \alias{registerInputHandler} \title{Register an Input Handler} diff --git a/man/removeInputHandler.Rd b/man/removeInputHandler.Rd index f4984bc26..eade67cdd 100644 --- a/man/removeInputHandler.Rd +++ b/man/removeInputHandler.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{removeInputHandler} \alias{removeInputHandler} \title{Deregister an Input Handler} diff --git a/man/renderDataTable.Rd b/man/renderDataTable.Rd index da92200f2..36de517eb 100644 --- a/man/renderDataTable.Rd +++ b/man/renderDataTable.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderDataTable} \alias{renderDataTable} \title{Table output with the JavaScript library DataTables} diff --git a/man/renderImage.Rd b/man/renderImage.Rd index 0fbc0b36a..d898b7cdc 100644 --- a/man/renderImage.Rd +++ b/man/renderImage.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderImage} \alias{renderImage} \title{Image file output} diff --git a/man/renderPlot.Rd b/man/renderPlot.Rd index 279be13ff..069172fde 100644 --- a/man/renderPlot.Rd +++ b/man/renderPlot.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderPlot} \alias{renderPlot} \title{Plot Output} diff --git a/man/renderPrint.Rd b/man/renderPrint.Rd index 39d4976ad..638ada7cc 100644 --- a/man/renderPrint.Rd +++ b/man/renderPrint.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderPrint} \alias{renderPrint} \title{Printable Output} diff --git a/man/renderTable.Rd b/man/renderTable.Rd index 2753ac25f..1ce2e2df1 100644 --- a/man/renderTable.Rd +++ b/man/renderTable.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderTable} \alias{renderTable} \title{Table Output} diff --git a/man/renderText.Rd b/man/renderText.Rd index 74da5280a..e117ed0de 100644 --- a/man/renderText.Rd +++ b/man/renderText.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderText} \alias{renderText} \title{Text Output} diff --git a/man/renderUI.Rd b/man/renderUI.Rd index 5cf350cd9..0594e3fe0 100644 --- a/man/renderUI.Rd +++ b/man/renderUI.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{renderUI} \alias{renderUI} \title{UI Output} diff --git a/man/repeatable.Rd b/man/repeatable.Rd index 711e5b1ce..091451f0e 100644 --- a/man/repeatable.Rd +++ b/man/repeatable.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{repeatable} \alias{repeatable} \title{Make a random number generator repeatable} diff --git a/man/runApp.Rd b/man/runApp.Rd index cefbd479a..6fc18e086 100644 --- a/man/runApp.Rd +++ b/man/runApp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{runApp} \alias{runApp} \title{Run Shiny Application} diff --git a/man/runExample.Rd b/man/runExample.Rd index cc1bd91bd..cf5ffd6e8 100644 --- a/man/runExample.Rd +++ b/man/runExample.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{runExample} \alias{runExample} \title{Run Shiny Example Applications} diff --git a/man/runGist.Rd b/man/runGist.Rd index e6b432de1..39733d024 100644 --- a/man/runGist.Rd +++ b/man/runGist.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{runGist} \alias{runGist} \title{Run a Shiny application from https://gist.github.com} diff --git a/man/runGitHub.Rd b/man/runGitHub.Rd index e7f58043f..3250eeae4 100644 --- a/man/runGitHub.Rd +++ b/man/runGitHub.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{runGitHub} \alias{runGitHub} \title{Run a Shiny application from a GitHub repository} diff --git a/man/runUrl.Rd b/man/runUrl.Rd index b0fd6efcc..4168c0e9b 100644 --- a/man/runUrl.Rd +++ b/man/runUrl.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{runUrl} \alias{runUrl} \title{Run a Shiny application from a URL} diff --git a/man/selectInput.Rd b/man/selectInput.Rd index 2e637a45f..94637e7a2 100644 --- a/man/selectInput.Rd +++ b/man/selectInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{selectInput} \alias{selectInput} \alias{selectizeInput} diff --git a/man/session.Rd b/man/session.Rd index d75d5b631..99470962d 100644 --- a/man/session.Rd +++ b/man/session.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{session} \alias{session} \title{Session object} diff --git a/man/shiny-package.Rd b/man/shiny-package.Rd index c30cd4dc9..6e49488f5 100644 --- a/man/shiny-package.Rd +++ b/man/shiny-package.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \docType{package} \name{shiny-package} \alias{shiny} diff --git a/man/shinyApp.Rd b/man/shinyApp.Rd index 5affd51c3..c2726ed74 100644 --- a/man/shinyApp.Rd +++ b/man/shinyApp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{shinyApp} \alias{as.shiny.appobj} \alias{as.shiny.appobj.character} diff --git a/man/shinyDeprecated.Rd b/man/shinyDeprecated.Rd index 91f5b9501..51d8503f1 100644 --- a/man/shinyDeprecated.Rd +++ b/man/shinyDeprecated.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{shinyDeprecated} \alias{shinyDeprecated} \title{Print message for deprecated functions in Shiny} diff --git a/man/shinyServer.Rd b/man/shinyServer.Rd index 95c903bc6..662efea22 100644 --- a/man/shinyServer.Rd +++ b/man/shinyServer.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{shinyServer} \alias{shinyServer} \title{Define Server Functionality} diff --git a/man/shinyUI.Rd b/man/shinyUI.Rd index 649f6281c..72d4b9762 100644 --- a/man/shinyUI.Rd +++ b/man/shinyUI.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{shinyUI} \alias{shinyUI} \title{Create a Shiny UI handler} diff --git a/man/showReactLog.Rd b/man/showReactLog.Rd index d7f543cd3..21034dbf7 100644 --- a/man/showReactLog.Rd +++ b/man/showReactLog.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{showReactLog} \alias{showReactLog} \title{Reactive Log Visualizer} diff --git a/man/sidebarLayout.Rd b/man/sidebarLayout.Rd index b67639b65..3d75d9f6d 100644 --- a/man/sidebarLayout.Rd +++ b/man/sidebarLayout.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{sidebarLayout} \alias{sidebarLayout} \title{Layout a sidebar and main area} diff --git a/man/sidebarPanel.Rd b/man/sidebarPanel.Rd index 915c2d985..d3dddf883 100644 --- a/man/sidebarPanel.Rd +++ b/man/sidebarPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{sidebarPanel} \alias{sidebarPanel} \title{Create a sidebar panel} diff --git a/man/singleton.Rd b/man/singleton.Rd new file mode 100644 index 000000000..483c27cf2 --- /dev/null +++ b/man/singleton.Rd @@ -0,0 +1,21 @@ +\name{singleton} +\alias{is.singleton} +\alias{singleton} +\title{Include content only once} +\usage{ +singleton(x, value = TRUE) + +is.singleton(x) +} +\arguments{ +\item{x}{A \code{\link{tag}}, text, \code{\link{HTML}}, or list.} + +\item{value}{Whether the object should be a singleton.} +} +\description{ +Use \code{singleton} to wrap contents (tag, text, HTML, or lists) that should +be included in the generated document only once, yet may appear in the +document-generating code more than once. Only the first appearance of the +content (in document order) will be used. +} + diff --git a/man/sliderInput.Rd b/man/sliderInput.Rd index dfb268698..f0d0cea12 100644 --- a/man/sliderInput.Rd +++ b/man/sliderInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{sliderInput} \alias{animationOptions} \alias{sliderInput} diff --git a/man/splitLayout.Rd b/man/splitLayout.Rd index b16e19814..9ce9afe63 100644 --- a/man/splitLayout.Rd +++ b/man/splitLayout.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{splitLayout} \alias{splitLayout} \title{Split layout} diff --git a/man/stopApp.Rd b/man/stopApp.Rd index a169583b8..4cd8cf43e 100644 --- a/man/stopApp.Rd +++ b/man/stopApp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{stopApp} \alias{stopApp} \title{Stop the currently running Shiny app} diff --git a/man/submitButton.Rd b/man/submitButton.Rd index 9a8373e8e..fe85dce56 100644 --- a/man/submitButton.Rd +++ b/man/submitButton.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{submitButton} \alias{submitButton} \title{Create a submit button} diff --git a/man/tabPanel.Rd b/man/tabPanel.Rd index 98ce970ad..71acb57c3 100644 --- a/man/tabPanel.Rd +++ b/man/tabPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{tabPanel} \alias{tabPanel} \title{Create a tab panel} diff --git a/man/tableOutput.Rd b/man/tableOutput.Rd index 065e14bd3..0d4430de6 100644 --- a/man/tableOutput.Rd +++ b/man/tableOutput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{tableOutput} \alias{dataTableOutput} \alias{tableOutput} diff --git a/man/tabsetPanel.Rd b/man/tabsetPanel.Rd index 4eac5fd49..5fbb28582 100644 --- a/man/tabsetPanel.Rd +++ b/man/tabsetPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{tabsetPanel} \alias{tabsetPanel} \title{Create a tabset panel} diff --git a/man/tag.Rd b/man/tag.Rd new file mode 100644 index 000000000..52c667d9e --- /dev/null +++ b/man/tag.Rd @@ -0,0 +1,64 @@ +\name{tagList} +\alias{tag} +\alias{tagAppendAttributes} +\alias{tagAppendChild} +\alias{tagAppendChildren} +\alias{tagList} +\alias{tagSetChildren} +\title{HTML Tag Object} +\usage{ +tagList(...) + +tagAppendAttributes(tag, ...) + +tagAppendChild(tag, child) + +tagAppendChildren(tag, ..., list = NULL) + +tagSetChildren(tag, ..., list = NULL) + +tag(`_tag_name`, varArgs) +} +\arguments{ +\item{_tag_name}{HTML tag name} + +\item{varArgs}{List of attributes and children of the element. Named list +items become attributes, and unnamed list items become children. Valid +children are tags, single-character character vectors (which become text +nodes), and raw HTML (see \code{\link{HTML}}). You can also pass lists that +contain tags, text nodes, and HTML.} + +\item{tag}{A tag to append child elements to.} + +\item{child}{A child element to append to a parent tag.} + +\item{...}{Unnamed items that comprise this list of tags.} + +\item{list}{An optional list of elements. Can be used with or instead of the +\code{...} items.} +} +\value{ +An HTML tag object that can be rendered as HTML using + \code{\link{as.character}()}. +} +\description{ +\code{tag()} creates an HTML tag definition. Note that all of the valid HTML5 +tags are already defined in the \code{\link{tags}} environment so these +functions should only be used to generate additional tags. +\code{tagAppendChild()} and \code{tagList()} are for supporting package +authors who wish to create their own sets of tags; see the contents of +bootstrap.R for examples. +} +\examples{ +tagList(tags$h1("Title"), + tags$h2("Header text"), + tags$p("Text here")) + +# Can also convert a regular list to a tagList (internal data structure isn't +# exactly the same, but when rendered to HTML, the output is the same). +x <- list(tags$h1("Title"), + tags$h2("Header text"), + tags$p("Text here")) +tagList(x) +} + diff --git a/man/textInput.Rd b/man/textInput.Rd index 0ffc56e88..4bb315f92 100644 --- a/man/textInput.Rd +++ b/man/textInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{textInput} \alias{textInput} \title{Create a text input control} diff --git a/man/textOutput.Rd b/man/textOutput.Rd index d029c90be..940e26b28 100644 --- a/man/textOutput.Rd +++ b/man/textOutput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{textOutput} \alias{textOutput} \title{Create a text output element} diff --git a/man/titlePanel.Rd b/man/titlePanel.Rd index dfaf75bf9..f319e1a3b 100644 --- a/man/titlePanel.Rd +++ b/man/titlePanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{titlePanel} \alias{titlePanel} \title{Create a panel containing an application title.} diff --git a/man/updateCheckboxGroupInput.Rd b/man/updateCheckboxGroupInput.Rd index f5e8bdb89..55dd8bf18 100644 --- a/man/updateCheckboxGroupInput.Rd +++ b/man/updateCheckboxGroupInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateCheckboxGroupInput} \alias{updateCheckboxGroupInput} \title{Change the value of a checkbox group input on the client} diff --git a/man/updateCheckboxInput.Rd b/man/updateCheckboxInput.Rd index a15ddff31..26173ad99 100644 --- a/man/updateCheckboxInput.Rd +++ b/man/updateCheckboxInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateCheckboxInput} \alias{updateCheckboxInput} \title{Change the value of a checkbox input on the client} diff --git a/man/updateDateInput.Rd b/man/updateDateInput.Rd index 9cbcedd69..2602bfdc2 100644 --- a/man/updateDateInput.Rd +++ b/man/updateDateInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateDateInput} \alias{updateDateInput} \title{Change the value of a date input on the client} diff --git a/man/updateDateRangeInput.Rd b/man/updateDateRangeInput.Rd index 7a2bfa6c2..d4852b8b7 100644 --- a/man/updateDateRangeInput.Rd +++ b/man/updateDateRangeInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateDateRangeInput} \alias{updateDateRangeInput} \title{Change the start and end values of a date range input on the client} diff --git a/man/updateNumericInput.Rd b/man/updateNumericInput.Rd index 802bc05cc..b7f4924d1 100644 --- a/man/updateNumericInput.Rd +++ b/man/updateNumericInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateNumericInput} \alias{updateNumericInput} \title{Change the value of a number input on the client} diff --git a/man/updateRadioButtons.Rd b/man/updateRadioButtons.Rd index 92495e770..ffbaae4c5 100644 --- a/man/updateRadioButtons.Rd +++ b/man/updateRadioButtons.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateRadioButtons} \alias{updateRadioButtons} \title{Change the value of a radio input on the client} diff --git a/man/updateSelectInput.Rd b/man/updateSelectInput.Rd index d1230a5a9..0f4131461 100644 --- a/man/updateSelectInput.Rd +++ b/man/updateSelectInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateSelectInput} \alias{updateSelectInput} \alias{updateSelectizeInput} diff --git a/man/updateSliderInput.Rd b/man/updateSliderInput.Rd index 19eac1b90..4481204d5 100644 --- a/man/updateSliderInput.Rd +++ b/man/updateSliderInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateSliderInput} \alias{updateSliderInput} \title{Change the value of a slider input on the client} diff --git a/man/updateTabsetPanel.Rd b/man/updateTabsetPanel.Rd index a5838a9fd..eb01869b1 100644 --- a/man/updateTabsetPanel.Rd +++ b/man/updateTabsetPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateTabsetPanel} \alias{updateTabsetPanel} \title{Change the selected tab on the client} diff --git a/man/updateTextInput.Rd b/man/updateTextInput.Rd index 555bc9206..9c4ed87b2 100644 --- a/man/updateTextInput.Rd +++ b/man/updateTextInput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{updateTextInput} \alias{updateTextInput} \title{Change the value of a text input on the client} diff --git a/man/validate.Rd b/man/validate.Rd index c29332c4a..104ddbb58 100644 --- a/man/validate.Rd +++ b/man/validate.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{validate} \alias{need} \alias{validate} diff --git a/man/validateCssUnit.Rd b/man/validateCssUnit.Rd new file mode 100644 index 000000000..d5b210359 --- /dev/null +++ b/man/validateCssUnit.Rd @@ -0,0 +1,36 @@ +\name{validateCssUnit} +\alias{validateCssUnit} +\title{Validate proper CSS formatting of a unit} +\usage{ +validateCssUnit(x) +} +\arguments{ +\item{x}{The unit to validate. Will be treated as a number of pixels if a +unit is not specified.} +} +\value{ +A properly formatted CSS unit of length, if possible. Otherwise, will + throw an error. +} +\description{ +Checks that the argument is valid for use as a CSS unit of length. +} +\details{ +\code{NULL} and \code{NA} are returned unchanged. + +Single element numeric vectors are returned as a character vector with the +number plus a suffix of \code{"px"}. + +Single element character vectors must be \code{"auto"} or \code{"inherit"}, +or a number. If the number has a suffix, it must be valid: \code{px}, +\code{\%}, \code{em}, \code{pt}, \code{in}, \code{cm}, \code{mm}, \code{ex}, +or \code{pc}. If the number has no suffix, the suffix \code{"px"} is +appended. + +Any other value will cause an error to be thrown. +} +\examples{ +validateCssUnit("10\%") +validateCssUnit(400) #treated as '400px' +} + diff --git a/man/verbatimTextOutput.Rd b/man/verbatimTextOutput.Rd index 2023621e3..9cdf73d72 100644 --- a/man/verbatimTextOutput.Rd +++ b/man/verbatimTextOutput.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{verbatimTextOutput} \alias{verbatimTextOutput} \title{Create a verbatim text output element} diff --git a/man/verticalLayout.Rd b/man/verticalLayout.Rd index 62bda66b5..6e146fb1e 100644 --- a/man/verticalLayout.Rd +++ b/man/verticalLayout.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{verticalLayout} \alias{verticalLayout} \title{Lay out UI elements vertically} diff --git a/man/wellPanel.Rd b/man/wellPanel.Rd index 13e9f7bef..91d7c07ef 100644 --- a/man/wellPanel.Rd +++ b/man/wellPanel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{wellPanel} \alias{wellPanel} \title{Create a well panel} diff --git a/man/withMathJax.Rd b/man/withMathJax.Rd index 1470f79e7..fbde1dd47 100644 --- a/man/withMathJax.Rd +++ b/man/withMathJax.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.0): do not edit by hand +% Generated by roxygen2 (4.0.1): do not edit by hand \name{withMathJax} \alias{withMathJax} \title{Load the MathJax library and typeset math expressions} diff --git a/man/withTags.Rd b/man/withTags.Rd new file mode 100644 index 000000000..f72dedea1 --- /dev/null +++ b/man/withTags.Rd @@ -0,0 +1,38 @@ +\name{withTags} +\alias{withTags} +\title{Evaluate an expression using \code{tags}} +\usage{ +withTags(code) +} +\arguments{ +\item{code}{A set of tags.} +} +\description{ +This function makes it simpler to write HTML-generating code. Instead of +needing to specify \code{tags} each time a tag function is used, as in +\code{tags$div()} and \code{tags$p()}, code inside \code{withTags} is +evaluated with \code{tags} searched first, so you can simply use +\code{div()} and \code{p()}. +} +\details{ +If your code uses an object which happens to have the same name as an +HTML tag function, such as \code{source()} or \code{summary()}, it will call +the tag function. To call the intended (non-tags function), specify the +namespace, as in \code{base::source()} or \code{base::summary()}. +} +\examples{ +# Using tags$ each time +tags$div(class = "myclass", + tags$h3("header"), + tags$p("text") +) + +# Equivalent to above, but using withTags +withTags( + div(class = "myclass", + h3("header"), + p("text") + ) +) +} + diff --git a/tools/importdocs.sh b/tools/importdocs.sh new file mode 100755 index 000000000..c56a3671f --- /dev/null +++ b/tools/importdocs.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env bash + +set -e + +# Grabs relevant man pages from htmltools and strips roxygen signature + +HTMLTOOLS_PATH="$HOME/Development/htmltools" + +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/HTML.Rd" > ../man/HTML.Rd +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/builder.Rd" > ../man/builder.Rd +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/include.Rd" > ../man/include.Rd +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/singleton.Rd" > ../man/singleton.Rd +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/tag.Rd" > ../man/tag.Rd +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/validateCssUnit.Rd" > ../man/validateCssUnit.Rd +sed '/% Generated by roxygen2 /d' "$HTMLTOOLS_PATH/man/withTags.Rd" > ../man/withTags.Rd