Skip to content

Commit

Permalink
using roxygen2 4.0.0: the spurious changes are due to r-lib/roxygen2#184
Browse files Browse the repository at this point in the history
 (text in Rd is no longer wrapped by default)
  • Loading branch information
yihui committed Feb 12, 2014
1 parent 398dab8 commit c4edae8
Show file tree
Hide file tree
Showing 100 changed files with 833 additions and 887 deletions.
2 changes: 2 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Generated by roxygen2 (4.0.0): do not edit by hand

S3method("$",reactivevalues)
S3method("$",shinyoutput)
S3method("$<-",reactivevalues)
Expand Down
5 changes: 3 additions & 2 deletions man/HTML.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{HTML}
\alias{HTML}
\title{Mark Characters as HTML}
Expand All @@ -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>"))
Expand Down
69 changes: 31 additions & 38 deletions man/absolutePanel.Rd
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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\%"}.
}
19 changes: 10 additions & 9 deletions man/actionButton.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{actionButton}
\alias{actionButton}
\title{Action button}
Expand All @@ -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{
Expand All @@ -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}}
}

17 changes: 8 additions & 9 deletions man/addResourcePath.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{addResourcePath}
\alias{addResourcePath}
\title{Resource Publishing}
Expand All @@ -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'))
Expand Down
22 changes: 10 additions & 12 deletions man/bootstrapPage.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{bootstrapPage}
\alias{basicPage}
\alias{bootstrapPage}
Expand All @@ -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}}
Expand Down
25 changes: 12 additions & 13 deletions man/checkboxGroupInput.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{checkboxGroupInput}
\alias{checkboxGroupInput}
\title{Checkbox Group Input Control}
Expand All @@ -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:",
Expand All @@ -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}}
}
20 changes: 10 additions & 10 deletions man/checkboxInput.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{checkboxInput}
\alias{checkboxInput}
\title{Checkbox Input Control}
Expand All @@ -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}}
}
5 changes: 3 additions & 2 deletions man/column.Rd
Original file line number Diff line number Diff line change
@@ -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}
Expand All @@ -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{
Expand Down
20 changes: 9 additions & 11 deletions man/conditionalPanel.Rd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
% Generated by roxygen2 (4.0.0): do not edit by hand
\name{conditionalPanel}
\alias{conditionalPanel}
\title{Conditional Panel}
Expand All @@ -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(
Expand Down
Loading

0 comments on commit c4edae8

Please sign in to comment.