PlotDataLabels() writes one text per row with FormatTemplate() (for
example titles such as "{cells:%.0f}k cells; {area:%.0f} mm2"), after
optional per-column scaling. PlotDataCollapse() writes every row and
joins the results into one text, for example to list patients with their
cell counts in a figure note.
Usage
PlotDataLabels(data, template, id = NULL, scales = NULL, into = "text")
PlotDataCollapse(
data,
template,
sep = "; ",
order_by = NULL,
decreasing = FALSE,
into = "text",
n_name = "rows"
)Arguments
- data
A data frame.
- template
Template (see
FormatTemplate()).- id
Optional columns of
datakept in the output ofPlotDataLabels().- scales
Named list: column to a multiplier applied before formatting.
- into
Name of the text column.
- sep
Separator of the collapsed rows.
- order_by
Optional column to sort by before collapsing (stable, increasing).
- decreasing
Sort decreasing.
- n_name
Name of a column with the number of rows collapsed.
Value
PlotDataLabels(): a data frame with the id columns and
into; PlotDataCollapse(): a one-row data frame.
See also
Other plot-data builders:
PlotDataBindRows(),
PlotDataConstant(),
PlotDataCount(),
PlotDataCrossShares(),
PlotDataDirection(),
PlotDataDominant(),
PlotDataFromArrays(),
PlotDataJoin(),
PlotDataKeyColours(),
PlotDataLonger(),
PlotDataMembership(),
PlotDataPairRatio(),
PlotDataProduct(),
PlotDataQuantiles(),
PlotDataRankRows(),
PlotDataRatio(),
PlotDataRecode(),
PlotDataRelative(),
PlotDataSelect(),
PlotDataShares(),
PlotDataSummarise(),
PlotDataUnite()
Examples
d <- data.frame(p = c("p3", "p1"), n = c(27081, 1450), g = c("A", "B"))
PlotDataLabels(d, "{n:%.0f}k cells, {g}", id = "p", scales = list(n = 0.001))
#> p text
#> 1 p3 27k cells, A
#> 2 p1 1k cells, B
PlotDataCollapse(d, "{p}, {n|comma}", order_by = "n")
#> text rows
#> 1 p1, 1,450; p3, 27,081 2