Skip to content

Commit 194d8a0

Browse files
committed
using the latest master of klutometis/roxygen (d823c3a088b20ea5e38a60d78d42ccbe9f1e1eec)
Rd text for arguments is no longer wrapped by default
1 parent 93e276b commit 194d8a0

File tree

99 files changed

+699
-875
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+699
-875
lines changed

man/HTML.Rd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
HTML(text, ...)
77
}
88
\arguments{
9-
\item{text}{The text value to mark with HTML}
9+
\item{text}{The text value to mark with HTML}
1010

11-
\item{...}{Any additional values to be converted to
12-
character and concatenated together}
11+
\item{...}{Any additional values to be converted to character and
12+
concatenated together}
1313
}
1414
\value{
1515
The same value, but marked as HTML.

man/absolutePanel.Rd

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,41 +13,37 @@ fixedPanel(..., top = NULL, left = NULL, right = NULL, bottom = NULL,
1313
"default", "inherit"))
1414
}
1515
\arguments{
16-
\item{...}{Attributes (named arguments) or children
17-
(unnamed arguments) that should be included in the
18-
panel.}
16+
\item{...}{Attributes (named arguments) or children (unnamed arguments) that
17+
should be included in the panel.}
1918

20-
\item{top}{Distance between the top of the panel, and the
21-
top of the page or parent container.}
19+
\item{top}{Distance between the top of the panel, and the top of the page or
20+
parent container.}
2221

23-
\item{left}{Distance between the left side of the panel,
24-
and the left of the page or parent container.}
22+
\item{left}{Distance between the left side of the panel, and the left of the
23+
page or parent container.}
2524

26-
\item{right}{Distance between the right side of the
27-
panel, and the right of the page or parent container.}
25+
\item{right}{Distance between the right side of the panel, and the right of
26+
the page or parent container.}
2827

29-
\item{bottom}{Distance between the bottom of the panel,
30-
and the bottom of the page or parent container.}
28+
\item{bottom}{Distance between the bottom of the panel, and the bottom of the
29+
page or parent container.}
3130

32-
\item{width}{Width of the panel.}
31+
\item{width}{Width of the panel.}
3332

34-
\item{height}{Height of the panel.}
33+
\item{height}{Height of the panel.}
3534

36-
\item{draggable}{If \code{TRUE}, allows the user to move
37-
the panel by clicking and dragging.}
35+
\item{draggable}{If \code{TRUE}, allows the user to move the panel by
36+
clicking and dragging.}
3837

39-
\item{fixed}{Positions the panel relative to the browser
40-
window and prevents it from being scrolled with the rest
41-
of the page.}
38+
\item{fixed}{Positions the panel relative to the browser window and prevents
39+
it from being scrolled with the rest of the page.}
4240

43-
\item{cursor}{The type of cursor that should appear when
44-
the user mouses over the panel. Use \code{"move"} for a
45-
north-east-south-west icon, \code{"default"} for the
46-
usual cursor arrow, or \code{"inherit"} for the usual
47-
cursor behavior (including changing to an I-beam when the
48-
cursor is over text). The default is \code{"auto"}, which
49-
is equivalent to \code{ifelse(draggable, "move",
50-
"inherit")}.}
41+
\item{cursor}{The type of cursor that should appear when the user mouses over
42+
the panel. Use \code{"move"} for a north-east-south-west icon,
43+
\code{"default"} for the usual cursor arrow, or \code{"inherit"} for the
44+
usual cursor behavior (including changing to an I-beam when the cursor is
45+
over text). The default is \code{"auto"}, which is equivalent to
46+
\code{ifelse(draggable, "move", "inherit")}.}
5147
}
5248
\value{
5349
An HTML element or list of elements.

man/actionButton.Rd

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@
66
actionButton(inputId, label, icon = NULL)
77
}
88
\arguments{
9-
\item{inputId}{Specifies the input slot that will be used
10-
to access the value.}
9+
\item{inputId}{Specifies the input slot that will be used to access the
10+
value.}
1111

12-
\item{label}{The contents of the button--usually a text
13-
label, but you could also use any other HTML, like an
14-
image.}
12+
\item{label}{The contents of the button--usually a text label, but you could
13+
also use any other HTML, like an image.}
1514

16-
\item{icon}{Optional \code{\link{icon}} to appear on the
17-
button}
15+
\item{icon}{Optional \code{\link{icon}} to appear on the button}
1816
}
1917
\description{
2018
Creates an action button whose value is initially zero, and increments by one

man/addResourcePath.Rd

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@
66
addResourcePath(prefix, directoryPath)
77
}
88
\arguments{
9-
\item{prefix}{The URL prefix (without slashes). Valid
10-
characters are a-z, A-Z, 0-9, hyphen, and underscore; and
11-
must begin with a-z or A-Z. For example, a value of 'foo'
12-
means that any request paths that begin with '/foo' will
13-
be mapped to the given directory.}
9+
\item{prefix}{The URL prefix (without slashes). Valid characters are a-z,
10+
A-Z, 0-9, hyphen, and underscore; and must begin with a-z or A-Z. For
11+
example, a value of 'foo' means that any request paths that begin with
12+
'/foo' will be mapped to the given directory.}
1413

15-
\item{directoryPath}{The directory that contains the
16-
static resources to be served.}
14+
\item{directoryPath}{The directory that contains the static resources to be
15+
served.}
1716
}
1817
\description{
1918
Adds a directory of static resources to Shiny's web server, with the given

man/bootstrapPage.Rd

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,15 @@ bootstrapPage(..., title = NULL, responsive = TRUE, theme = NULL)
99
basicPage(...)
1010
}
1111
\arguments{
12-
\item{...}{The contents of the document body.}
12+
\item{...}{The contents of the document body.}
1313

14-
\item{title}{The browser window title (defaults to the
15-
host URL of the page)}
14+
\item{title}{The browser window title (defaults to the host URL of the page)}
1615

17-
\item{responsive}{\code{TRUE} to use responsive layout
18-
(automatically adapt and resize page elements based on
19-
the size of the viewing device)}
16+
\item{responsive}{\code{TRUE} to use responsive layout (automatically adapt
17+
and resize page elements based on the size of the viewing device)}
2018

21-
\item{theme}{Alternative Bootstrap stylesheet (normally a
22-
css file within the www directory, e.g.
23-
\code{www/bootstrap.css})}
19+
\item{theme}{Alternative Bootstrap stylesheet (normally a css file within the
20+
www directory, e.g. \code{www/bootstrap.css})}
2421
}
2522
\value{
2623
A UI defintion that can be passed to the \link{shinyUI} function.

man/builder.Rd

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,11 @@ hr(...)
5858
tags
5959
}
6060
\arguments{
61-
\item{...}{Attributes and children of the element. Named
62-
arguments become attributes, and positional arguments
63-
become children. Valid children are tags,
64-
single-character character vectors (which become text
65-
nodes), and raw HTML (see \code{\link{HTML}}). You can
66-
also pass lists that contain tags, text nodes, and HTML.}
61+
\item{...}{Attributes and children of the element. Named arguments become
62+
attributes, and positional arguments become children. Valid children are
63+
tags, single-character character vectors (which become text nodes), and raw
64+
HTML (see \code{\link{HTML}}). You can also pass lists that contain tags,
65+
text nodes, and HTML.}
6766
}
6867
\description{
6968
Simple functions for constructing HTML documents.

man/checkboxGroupInput.Rd

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,14 @@
66
checkboxGroupInput(inputId, label, choices, selected = NULL)
77
}
88
\arguments{
9-
\item{inputId}{Input variable to assign the control's
10-
value to.}
9+
\item{inputId}{Input variable to assign the control's value to.}
1110
12-
\item{label}{Display label for the control.}
11+
\item{label}{Display label for the control.}
1312
14-
\item{choices}{List of values to show checkboxes for. If
15-
elements of the list are named then that name rather than
16-
the value is displayed to the user.}
13+
\item{choices}{List of values to show checkboxes for. If elements of the list
14+
are named then that name rather than the value is displayed to the user.}
1715
18-
\item{selected}{The values that should be initially
19-
selected, if any.}
16+
\item{selected}{The values that should be initially selected, if any.}
2017
}
2118
\value{
2219
A list of HTML elements that can be added to a UI definition.

man/checkboxInput.Rd

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,11 @@
66
checkboxInput(inputId, label, value = FALSE)
77
}
88
\arguments{
9-
\item{inputId}{Input variable to assign the control's
10-
value to.}
9+
\item{inputId}{Input variable to assign the control's value to.}
1110
12-
\item{label}{Display label for the control.}
11+
\item{label}{Display label for the control.}
1312
14-
\item{value}{Initial value (\code{TRUE} or
15-
\code{FALSE}).}
13+
\item{value}{Initial value (\code{TRUE} or \code{FALSE}).}
1614
}
1715
\value{
1816
A checkbox control that can be added to a UI definition.

man/column.Rd

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@
66
column(width, ..., offset = 0)
77
}
88
\arguments{
9-
\item{width}{The grid width of the column (must be
10-
between 1 and 12)}
9+
\item{width}{The grid width of the column (must be between 1 and 12)}
1110

12-
\item{...}{Elements to include within the column}
11+
\item{...}{Elements to include within the column}
1312

14-
\item{offset}{The number of columns to offset this column
15-
from the end of the previous column.}
13+
\item{offset}{The number of columns to offset this column from the end of the
14+
previous column.}
1615
}
1716
\value{
1817
A column that can be included within a

man/conditionalPanel.Rd

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@
66
conditionalPanel(condition, ...)
77
}
88
\arguments{
9-
\item{condition}{A JavaScript expression that will be
10-
evaluated repeatedly to determine whether the panel
11-
should be displayed.}
9+
\item{condition}{A JavaScript expression that will be evaluated repeatedly to
10+
determine whether the panel should be displayed.}
1211

13-
\item{...}{Elements to include in the panel.}
12+
\item{...}{Elements to include in the panel.}
1413
}
1514
\description{
1615
Creates a panel that is visible or not, depending on the value of a

0 commit comments

Comments
 (0)