propsa-setter: Update Graphical Properties for Selected Table Elements
In tablesgg: Presentation-Quality Tables, Displayed Using 'ggplot2'
propsa<- R Documentation
Update Graphical Properties for Selected Table Elements
Description
Update the graphical properties of table elements in selected rows and
columns of a plotted table.
Usage
propsa(x, arows=NULL, acols=NULL, setEnabled=TRUE) <- value
Arguments
x
A pltdTable object containing a plotted table.
arows, acols
Numeric vectors of row and column numbers in the table's augmented
row-column grid. The default value of NULL means all rows or columns.
Use half-integer values to refer to the locations of horizontal or
vertical rules running between rows or columns.
setEnabled
Logical scalar. If TRUE then any element whose properties are updated by
this function will have its enabled value set to TRUE (and thus
will be displayed in a plot). enabled will not be changed for
elements that are not updated. If setEnabled is FALSE,
enabled is not changed for any elements.
value
An element_entry, element_refmark, element_hvrule, or
element_block object that contains the new values for graphical
properties.
Details
There are three similar functions that can be used to modify the graphical
properties of table elements: props<-, propsa<-, and
propsd<-. They differ only in how one specifies which elements are
to be modified. props<- uses element or block ID, or searches the
text content of entries. propsa<- uses explicit row and column
numbers within the augmented row-column grid. propsd<- uses the
values of element descriptors (as described in ?elements).
The type of elements that are updated is determined by value: if
value is an element_entry or element_refmark object
then entries are updated; if it is an element_hvrule object then
hvrules are; if it is an element_block object then blocks are. See
the documentation for props<- for discussion of their use.
For this function the selected elements are those which are (a) completely
contained within the rows listed in arows and the columns listed in
acols; and (b) of a type (entry, block, or hvrule) corresponding to
the class of value. For (a), arows and acols are
treated as _sets_ of row/column numbers, not _ranges_. For example, a
horizontal rule running between rows 3 and 4 will not be selected by
arows=c(3, 4); the value 3.5 must be included in arows.
The helper functions arow and acol provide a partial bridge
between this function and props<-. They return row and column
numbers associated with particular element IDs, or with specified values
of the row and column headers. For example, propsa(plt,
arows=arow(plt, id="body"), acols=acol(plt, id="body")) is equivalent to
props(plt, id="body"). See the examples below for cases where the
combination of propsa<- and arow/acol is more
convenient than props<- alone.
This function overrides graphical properties in x that may have
been set by a style. Therefore the value of style_row is set to NA
for any elements whose properties are updated by this function.
Value
An object like x, with updated graphical properties for the
selected elements.
See Also
element_entry, element_refmark,
element_hvrule, element_block,
arow, acol, props<-,
propsd<-
Examples
plt <- plot(iris2_tab, title="Summary statistics for the iris data")
plt2 <- plt
# Change the title to italics:
propsa(plt2, arows=1) <- element_entry(fontface=3)
# Change the vertical rule between row header and body from empty to
# a solid line:
propsa(plt2, acols=2.5) <- element_hvrule(linetype=1, color="black",
size=0.5)
# Put all the mean values in bold face:
propsa(plt2, arows=arow(plt2, hpath=c(NA, "mean")),
acols=acol(plt2, id="body")) <- element_entry(fontface=2)
plt3 <- plt
# Use shading to highlight the rows for the 'versicolor' species:
propsa(plt3, arows=arow(plt3, hpath=c("versicolor"))) <-
element_block(fill="gray85")
# Compare tables before and after modification:
print(plt, vpx=0.25, vpy=0.75)
print(plt2, vpx=0.75, vpy=0.75, newpage=FALSE)
print(plt3, vpx=0.5, vpy=0.25, newpage=FALSE)
# Striping every other row in a data frame listing (must include row names):
data(mtcars, package="datasets")
plt <- plot(textTable(head(mtcars, 10),
title="Partial listing of the 'mtcars' data frame"))
ar <- arow(plt, id="body")
propsa(plt, arows=ar[ar %% 2 == 0]) <- element_block(fill="gray85")
plt
tablesgg documentation built on June 22, 2024, 11:02 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| propsa<- | R Documentation |
Update Graphical Properties for Selected Table Elements
Description
Update the graphical properties of table elements in selected rows and columns of a plotted table.
Usage
propsa(x, arows=NULL, acols=NULL, setEnabled=TRUE) <- value
Arguments
x |
A |
arows, acols |
Numeric vectors of row and column numbers in the table's augmented row-column grid. The default value of NULL means all rows or columns. Use half-integer values to refer to the locations of horizontal or vertical rules running between rows or columns. |
setEnabled |
Logical scalar. If TRUE then any element whose properties are updated by
this function will have its |
value |
An |
Details
There are three similar functions that can be used to modify the graphical
properties of table elements: props<-, propsa<-, and
propsd<-. They differ only in how one specifies which elements are
to be modified. props<- uses element or block ID, or searches the
text content of entries. propsa<- uses explicit row and column
numbers within the augmented row-column grid. propsd<- uses the
values of element descriptors (as described in ?elements).
The type of elements that are updated is determined by value: if
value is an element_entry or element_refmark object
then entries are updated; if it is an element_hvrule object then
hvrules are; if it is an element_block object then blocks are. See
the documentation for props<- for discussion of their use.
For this function the selected elements are those which are (a) completely
contained within the rows listed in arows and the columns listed in
acols; and (b) of a type (entry, block, or hvrule) corresponding to
the class of value. For (a), arows and acols are
treated as _sets_ of row/column numbers, not _ranges_. For example, a
horizontal rule running between rows 3 and 4 will not be selected by
arows=c(3, 4); the value 3.5 must be included in arows.
The helper functions arow and acol provide a partial bridge
between this function and props<-. They return row and column
numbers associated with particular element IDs, or with specified values
of the row and column headers. For example, propsa(plt,
arows=arow(plt, id="body"), acols=acol(plt, id="body")) is equivalent to
props(plt, id="body"). See the examples below for cases where the
combination of propsa<- and arow/acol is more
convenient than props<- alone.
This function overrides graphical properties in x that may have
been set by a style. Therefore the value of style_row is set to NA
for any elements whose properties are updated by this function.
Value
An object like x, with updated graphical properties for the
selected elements.
See Also
element_entry, element_refmark,
element_hvrule, element_block,
arow, acol, props<-,
propsd<-
Examples
plt <- plot(iris2_tab, title="Summary statistics for the iris data")
plt2 <- plt
# Change the title to italics:
propsa(plt2, arows=1) <- element_entry(fontface=3)
# Change the vertical rule between row header and body from empty to
# a solid line:
propsa(plt2, acols=2.5) <- element_hvrule(linetype=1, color="black",
size=0.5)
# Put all the mean values in bold face:
propsa(plt2, arows=arow(plt2, hpath=c(NA, "mean")),
acols=acol(plt2, id="body")) <- element_entry(fontface=2)
plt3 <- plt
# Use shading to highlight the rows for the 'versicolor' species:
propsa(plt3, arows=arow(plt3, hpath=c("versicolor"))) <-
element_block(fill="gray85")
# Compare tables before and after modification:
print(plt, vpx=0.25, vpy=0.75)
print(plt2, vpx=0.75, vpy=0.75, newpage=FALSE)
print(plt3, vpx=0.5, vpy=0.25, newpage=FALSE)
# Striping every other row in a data frame listing (must include row names):
data(mtcars, package="datasets")
plt <- plot(textTable(head(mtcars, 10),
title="Partial listing of the 'mtcars' data frame"))
ar <- arow(plt, id="body")
propsa(plt, arows=ar[ar %% 2 == 0]) <- element_block(fill="gray85")
plt
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.