Permalink
Browse files

using roxygen2 4.0.0: the spurious changes are due to klutometis/roxy…

…gen#184 (text in Rd is no longer wrapped by default)
  • Loading branch information...
1 parent 398dab8 commit c4edae819664ddd1cff9197f8a3745ec2e8deede @yihui yihui committed Feb 12, 2014
Showing with 833 additions and 887 deletions.
  1. +2 −0 NAMESPACE
  2. +3 −2 man/HTML.Rd
  3. +31 −38 man/absolutePanel.Rd
  4. +10 −9 man/actionButton.Rd
  5. +8 −9 man/addResourcePath.Rd
  6. +10 −12 man/bootstrapPage.Rd
  7. +12 −13 man/checkboxGroupInput.Rd
  8. +10 −10 man/checkboxInput.Rd
  9. +3 −2 man/column.Rd
  10. +9 −11 man/conditionalPanel.Rd
  11. +25 −20 man/dateInput.Rd
  12. +24 −20 man/dateRangeInput.Rd
  13. +4 −4 man/downloadButton.Rd
  14. +8 −8 man/downloadHandler.Rd
  15. +8 −8 man/exprToFunction.Rd
  16. +27 −22 man/fileInput.Rd
  17. +17 −21 man/fixedPage.Rd
  18. +15 −19 man/fluidPage.Rd
  19. +1 −0 man/headerPanel.Rd
  20. +3 −2 man/helpText.Rd
  21. +6 −7 man/htmlOutput.Rd
  22. +4 −3 man/icon.Rd
  23. +1 −0 man/imageOutput.Rd
  24. +13 −15 man/include.Rd
  25. +7 −7 man/installExprFunction.Rd
  26. +9 −11 man/invalidateLater.Rd
  27. +1 −0 man/is.reactivevalues.Rd
  28. +16 −20 man/isolate.Rd
  29. +4 −4 man/mainPanel.Rd
  30. +5 −5 man/makeReactiveBinding.Rd
  31. +7 −8 man/navbarPage.Rd
  32. +5 −6 man/navlistPanel.Rd
  33. +9 −8 man/numericInput.Rd
  34. +38 −35 man/observe.Rd
  35. +9 −8 man/outputOptions.Rd
  36. +6 −9 man/pageWithSidebar.Rd
  37. +1 −0 man/parseQueryString.Rd
  38. +1 −0 man/plotOutput.Rd
  39. +13 −14 man/plotPNG.Rd
  40. +10 −10 man/radioButtons.Rd
  41. +12 −15 man/reactive.Rd
  42. +12 −13 man/reactiveFileReader.Rd
  43. +1 −0 man/reactivePlot.Rd
  44. +22 −28 man/reactivePoll.Rd
  45. +1 −0 man/reactivePrint.Rd
  46. +1 −0 man/reactiveTable.Rd
  47. +1 −0 man/reactiveText.Rd
  48. +13 −15 man/reactiveTimer.Rd
  49. +1 −0 man/reactiveUI.Rd
  50. +6 −7 man/reactiveValues.Rd
  51. +5 −6 man/reactiveValuesToList.Rd
  52. +13 −16 man/registerInputHandler.Rd
  53. +5 −5 man/removeInputHandler.Rd
  54. +5 −5 man/renderDataTable.Rd
  55. +19 −21 man/renderImage.Rd
  56. +7 −7 man/renderPlot.Rd
  57. +17 −19 man/renderPrint.Rd
  58. +5 −4 man/renderTable.Rd
  59. +12 −13 man/renderText.Rd
  60. +5 −5 man/renderUI.Rd
  61. +7 −7 man/repeatable.Rd
  62. +8 −10 man/runApp.Rd
  63. +2 −2 man/runExample.Rd
  64. +2 −2 man/runGist.Rd
  65. +2 −2 man/runGitHub.Rd
  66. +5 −5 man/runUrl.Rd
  67. +8 −6 man/selectInput.Rd
  68. +8 −9 man/shiny-package.Rd
  69. +2 −2 man/shinyDeprecated.Rd
  70. +13 −15 man/shinyServer.Rd
  71. +4 −3 man/shinyUI.Rd
  72. +24 −28 man/showReactLog.Rd
  73. +4 −4 man/sidebarLayout.Rd
  74. +3 −2 man/sidebarPanel.Rd
  75. +6 −6 man/singleton.Rd
  76. +17 −20 man/sliderInput.Rd
  77. +3 −2 man/stopApp.Rd
  78. +11 −10 man/submitButton.Rd
  79. +2 −2 man/tabPanel.Rd
  80. +1 −0 man/tableOutput.Rd
  81. +3 −3 man/tabsetPanel.Rd
  82. +9 −8 man/textInput.Rd
  83. +5 −5 man/textOutput.Rd
  84. +3 −3 man/titlePanel.Rd
  85. +9 −12 man/updateCheckboxGroupInput.Rd
  86. +11 −14 man/updateCheckboxInput.Rd
  87. +9 −12 man/updateDateInput.Rd
  88. +10 −14 man/updateDateRangeInput.Rd
  89. +9 −12 man/updateNumericInput.Rd
  90. +9 −12 man/updateRadioButtons.Rd
  91. +9 −12 man/updateSelectInput.Rd
  92. +11 −14 man/updateSliderInput.Rd
  93. +1 −0 man/updateTabsetPanel.Rd
  94. +11 −14 man/updateTextInput.Rd
  95. +9 −10 man/validateCssUnit.Rd
  96. +7 −8 man/verbatimTextOutput.Rd
  97. +3 −3 man/verticalLayout.Rd
  98. +3 −3 man/wellPanel.Rd
  99. +9 −10 man/withTags.Rd
  100. +3 −2 shiny.Rproj
View
@@ -1,3 +1,5 @@
+# Generated by roxygen2 (4.0.0): do not edit by hand
+
S3method("$",reactivevalues)
S3method("$",shinyoutput)
S3method("$<-",reactivevalues)
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{HTML}
\alias{HTML}
\title{Mark Characters as HTML}
@@ -14,8 +15,8 @@ HTML(text, ...)
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.
+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 <u>turtles</u>"))
View
@@ -1,17 +1,16 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{absolutePanel}
\alias{absolutePanel}
\alias{fixedPanel}
\title{Panel with absolute positioning}
\usage{
- absolutePanel(..., top = NULL, left = NULL, right = NULL,
- bottom = NULL, width = NULL, height = NULL,
- draggable = FALSE, fixed = FALSE,
- cursor = c("auto", "move", "default", "inherit"))
+absolutePanel(..., top = NULL, left = NULL, right = NULL, bottom = NULL,
+ width = NULL, height = NULL, draggable = FALSE, fixed = FALSE,
+ cursor = c("auto", "move", "default", "inherit"))
- fixedPanel(..., top = NULL, left = NULL, right = NULL,
- bottom = NULL, width = NULL, height = NULL,
- draggable = FALSE,
- cursor = c("move", "default", "inherit"))
+fixedPanel(..., top = NULL, left = NULL, right = NULL, bottom = NULL,
+ width = NULL, height = NULL, draggable = FALSE, cursor = c("move",
+ "default", "inherit"))
}
\arguments{
\item{...}{Attributes (named arguments) or children
@@ -51,43 +50,37 @@
"inherit")}.}
}
\value{
- An HTML element or list of elements.
+An HTML element or list of elements.
}
\description{
- Creates a panel whose contents are absolutely positioned.
+Creates a panel whose contents are absolutely positioned.
}
\details{
- The \code{absolutePanel} function creates a \code{<div>}
- tag whose CSS position is set to \code{absolute} (or
- fixed if \code{fixed = TRUE}). The way absolute
- positioning works in HTML is that absolute coordinates
- are specified relative to its nearest parent element
- whose position is not set to \code{static} (which is the
- default), and if no such parent is found, then relative
- to the page borders. If you're not sure what that means,
- just keep in mind that you may get strange results if you
- use \code{absolutePanel} from inside of certain types of
- panels.
+The \code{absolutePanel} function creates a \code{<div>} tag whose CSS
+position is set to \code{absolute} (or fixed if \code{fixed = TRUE}). The way
+absolute positioning works in HTML is that absolute coordinates are specified
+relative to its nearest parent element whose position is not set to
+\code{static} (which is the default), and if no such parent is found, then
+relative to the page borders. If you're not sure what that means, just keep
+in mind that you may get strange results if you use \code{absolutePanel} from
+inside of certain types of panels.
- The \code{fixedPanel} function is the same as
- \code{absolutePanel} with \code{fixed = TRUE}.
+The \code{fixedPanel} function is the same as \code{absolutePanel} with
+\code{fixed = TRUE}.
- The position (\code{top}, \code{left}, \code{right},
- \code{bottom}) and size (\code{width}, \code{height})
- parameters are all optional, but you should specify
- exactly two of \code{top}, \code{bottom}, and
- \code{height} and exactly two of \code{left},
- \code{right}, and \code{width} for predictable results.
+The position (\code{top}, \code{left}, \code{right}, \code{bottom}) and size
+(\code{width}, \code{height}) parameters are all optional, but you should
+specify exactly two of \code{top}, \code{bottom}, and \code{height} and
+exactly two of \code{left}, \code{right}, and \code{width} for predictable
+results.
- Like most other distance parameters in Shiny, the
- position and size parameters take a number (interpreted
- as pixels) or a valid CSS size string, such as
- \code{"100px"} (100 pixels) or \code{"25\%"}.
+Like most other distance parameters in Shiny, the position and size
+parameters take a number (interpreted as pixels) or a valid CSS size string,
+such as \code{"100px"} (100 pixels) or \code{"25\%"}.
- For arcane HTML reasons, to have the panel fill the page
- or parent you should specify \code{0} for \code{top},
- \code{left}, \code{right}, and \code{bottom} rather than
- the more obvious \code{width = "100\%"} and \code{height
- = "100\%"}.
+For arcane HTML reasons, to have the panel fill the page or parent you should
+specify \code{0} for \code{top}, \code{left}, \code{right}, and \code{bottom}
+rather than the more obvious \code{width = "100\%"} and \code{height =
+"100\%"}.
}
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{actionButton}
\alias{actionButton}
\title{Action button}
@@ -16,8 +17,8 @@ actionButton(inputId, label, icon = NULL)
button}
}
\description{
-Creates an action button whose value is initially zero, and
-increments by one each time it is pressed.
+Creates an action button whose value is initially zero, and increments by one
+each time it is pressed.
}
\examples{
\dontrun{
@@ -37,12 +38,12 @@ actionButton("goButton", "Go!")
}
\seealso{
Other input.elements: \code{\link{animationOptions}},
-\code{\link{sliderInput}};
-\code{\link{checkboxGroupInput}};
-\code{\link{checkboxInput}}; \code{\link{dateInput}};
-\code{\link{dateRangeInput}}; \code{\link{fileInput}};
-\code{\link{numericInput}}; \code{\link{radioButtons}};
-\code{\link{selectInput}}; \code{\link{submitButton}};
-\code{\link{textInput}}
+ \code{\link{sliderInput}};
+ \code{\link{checkboxGroupInput}};
+ \code{\link{checkboxInput}}; \code{\link{dateInput}};
+ \code{\link{dateRangeInput}}; \code{\link{fileInput}};
+ \code{\link{numericInput}}; \code{\link{radioButtons}};
+ \code{\link{selectInput}}; \code{\link{submitButton}};
+ \code{\link{textInput}}
}
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{addResourcePath}
\alias{addResourcePath}
\title{Resource Publishing}
@@ -15,17 +16,15 @@ addResourcePath(prefix, directoryPath)
static resources to be served.}
}
\description{
-Adds a directory of static resources to Shiny's web server,
-with the given path prefix. Primarily intended for package
-authors to make supporting JavaScript/CSS files available
-to their components.
+Adds a directory of static resources to Shiny's web server, with the given
+path prefix. Primarily intended for package authors to make supporting
+JavaScript/CSS files available to their components.
}
\details{
-You can call \code{addResourcePath} multiple times for a
-given \code{prefix}; only the most recent value will be
-retained. If the normalized \code{directoryPath} is
-different than the directory that's currently mapped to the
-\code{prefix}, a warning will be issued.
+You can call \code{addResourcePath} multiple times for a given
+ \code{prefix}; only the most recent value will be retained. If the
+ normalized \code{directoryPath} is different than the directory that's
+ currently mapped to the \code{prefix}, a warning will be issued.
}
\examples{
addResourcePath('datasets', system.file('data', package='datasets'))
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{bootstrapPage}
\alias{basicPage}
\alias{bootstrapPage}
@@ -22,25 +23,22 @@ basicPage(...)
\code{www/bootstrap.css})}
}
\value{
-A UI defintion that can be passed to the \link{shinyUI}
-function.
+A UI defintion that can be passed to the \link{shinyUI} function.
}
\description{
-Create a Shiny UI page that loads the CSS and JavaScript
-for \href{http://getbootstrap.com/2.3.2/}{Bootstrap}, and
-has no content in the page body (other than what you
-provide).
+Create a Shiny UI page that loads the CSS and JavaScript for
+\href{http://getbootstrap.com/2.3.2/}{Bootstrap}, and has no content in the
+page body (other than what you provide).
}
\details{
-This function is primarily intended for users who are
-proficient in HTML/CSS, and know how to lay out pages in
-Bootstrap. Most applications should use
-\code{\link{fluidPage}} along with layout functions like
+This function is primarily intended for users who are proficient in
+HTML/CSS, and know how to lay out pages in Bootstrap. Most applications
+should use \code{\link{fluidPage}} along with layout functions like
\code{\link{fluidRow}} and \code{\link{sidebarLayout}}.
}
\note{
-The \code{basicPage} function is deprecated, you should use
-the \code{\link{fluidPage}} function instead.
+The \code{basicPage} function is deprecated, you should use the
+ \code{\link{fluidPage}} function instead.
}
\seealso{
\code{\link{fluidPage}}, \code{\link{fixedPage}}
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{checkboxGroupInput}
\alias{checkboxGroupInput}
\title{Checkbox Group Input Control}
@@ -18,13 +19,12 @@ checkboxGroupInput(inputId, label, choices, selected = NULL)
selected, if any.}
}
\value{
-A list of HTML elements that can be added to a UI
-definition.
+A list of HTML elements that can be added to a UI definition.
}
\description{
-Create a group of checkboxes that can be used to toggle
-multiple choices independently. The server will receive the
-input as a character vector of the selected values.
+Create a group of checkboxes that can be used to toggle multiple choices
+independently. The server will receive the input as a character vector of the
+selected values.
}
\examples{
checkboxGroupInput("variable", "Variable:",
@@ -33,15 +33,14 @@ checkboxGroupInput("variable", "Variable:",
"Gears" = "gear"))
}
\seealso{
-\code{\link{checkboxInput}},
-\code{\link{updateCheckboxGroupInput}}
+\code{\link{checkboxInput}}, \code{\link{updateCheckboxGroupInput}}
Other input.elements: \code{\link{actionButton}};
-\code{\link{animationOptions}}, \code{\link{sliderInput}};
-\code{\link{checkboxInput}}; \code{\link{dateInput}};
-\code{\link{dateRangeInput}}; \code{\link{fileInput}};
-\code{\link{numericInput}}; \code{\link{radioButtons}};
-\code{\link{selectInput}}; \code{\link{submitButton}};
-\code{\link{textInput}}
+ \code{\link{animationOptions}},
+ \code{\link{sliderInput}}; \code{\link{checkboxInput}};
+ \code{\link{dateInput}}; \code{\link{dateRangeInput}};
+ \code{\link{fileInput}}; \code{\link{numericInput}};
+ \code{\link{radioButtons}}; \code{\link{selectInput}};
+ \code{\link{submitButton}}; \code{\link{textInput}}
}
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{checkboxInput}
\alias{checkboxInput}
\title{Checkbox Input Control}
@@ -17,22 +18,21 @@ checkboxInput(inputId, label, value = FALSE)
A checkbox control that can be added to a UI definition.
}
\description{
-Create a checkbox that can be used to specify logical
-values.
+Create a checkbox that can be used to specify logical values.
}
\examples{
checkboxInput("outliers", "Show outliers", FALSE)
}
\seealso{
-\code{\link{checkboxGroupInput}},
-\code{\link{updateCheckboxInput}}
+\code{\link{checkboxGroupInput}}, \code{\link{updateCheckboxInput}}
Other input.elements: \code{\link{actionButton}};
-\code{\link{animationOptions}}, \code{\link{sliderInput}};
-\code{\link{checkboxGroupInput}}; \code{\link{dateInput}};
-\code{\link{dateRangeInput}}; \code{\link{fileInput}};
-\code{\link{numericInput}}; \code{\link{radioButtons}};
-\code{\link{selectInput}}; \code{\link{submitButton}};
-\code{\link{textInput}}
+ \code{\link{animationOptions}},
+ \code{\link{sliderInput}};
+ \code{\link{checkboxGroupInput}};
+ \code{\link{dateInput}}; \code{\link{dateRangeInput}};
+ \code{\link{fileInput}}; \code{\link{numericInput}};
+ \code{\link{radioButtons}}; \code{\link{selectInput}};
+ \code{\link{submitButton}}; \code{\link{textInput}}
}
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{column}
\alias{column}
\title{Create a column within a UI definition}
@@ -15,10 +16,10 @@ column(width, ..., offset = 0)
}
\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
+Create a column for use within a \code{\link{fluidRow}} or
\code{\link{fixedRow}}
}
\examples{
View
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{conditionalPanel}
\alias{conditionalPanel}
\title{Conditional Panel}
@@ -12,19 +13,16 @@ conditionalPanel(condition, ...)
\item{...}{Elements to include in the panel.}
}
\description{
-Creates a panel that is visible or not, depending on the
-value of a JavaScript expression. The JS expression is
-evaluated once at startup and whenever Shiny detects a
-relevant change in input/output.
+Creates a panel that is visible or not, depending on the value of a
+JavaScript expression. The JS expression is evaluated once at startup and
+whenever Shiny detects a relevant change in input/output.
}
\details{
-In the JS expression, you can refer to \code{input} and
-\code{output} JavaScript objects that contain the current
-values of input and output. For example, if you have an
-input with an id of \code{foo}, then you can use
-\code{input.foo} to read its value. (Be sure not to modify
-the input/output objects, as this may cause unpredictable
-behavior.)
+In the JS expression, you can refer to \code{input} and \code{output}
+JavaScript objects that contain the current values of input and output. For
+example, if you have an input with an id of \code{foo}, then you can use
+\code{input.foo} to read its value. (Be sure not to modify the input/output
+objects, as this may cause unpredictable behavior.)
}
\examples{
sidebarPanel(
Oops, something went wrong.

0 comments on commit c4edae8

Please sign in to comment.