Align "count (parenthetical)" cells

Aligns clinical cells made of an integer count followed by a parenthetical part – e.g. "69 (80.2%)", "3 (<1%)", "70 (100%)". It scans the whole column, then right-justifies the count to the widest count and right-justifies the text inside the parentheses to the widest one, so the count digit and the percentage line up across rows.

Usage

fmt_count_paren(x, nbsp = " ", na = "", bare = FALSE)

Arguments

x

Character vector (one table column).

nbsp

Padding character; defaults to the non-breaking space (U+00A0) so RTF / Word keep the alignment. Pass " " for plain text.

na

Text to print for a missing value (NA, and NaN – R counts it as missing). The default "" leaves the cell empty, as before. A non-empty token is right-justified with the other cells, so its right edge lines up with theirs. Inf / -Inf are not missing and print as "Inf" / "-Inf". See the na argument of as_rtftables().

bare

FALSE (default) leaves a cell with no parentheses as it is; TRUE also pads a bare integer count (a lone "0", a raw event total) into the count field, so it lines up under the parenthetical cells. (It was fmt_count_paren_bare(), deprecated.)

Value

Character vector the same length as x.

Details

Only cells that have parentheses are touched; cells without them – a lone count such as "0" or a raw total, a continuous statistic like "75.2 (8.6)" whose "count" is not an integer, free text, or empty group-label cells – are returned unchanged. With bare = TRUE a bare integer count is padded into the same count field too, so it lines up under the parenthetical cells.

Unlike the fixed-width align_count_pct = TRUE this adapts to the column's actual digit counts and does not care what is inside the parentheses, coping with mixed notations like "(<1%)", "(100%)" and "( 2.8%)" in one column (e.g. tables produced by tfrmt).

With na set, a missing cell prints that token right-justified in the count field – its right edge under the ones digit – so it stays in line instead of falling out of the column.

See also

fmt_value_paren() (any text before the parenthesis), fmt_right_align(), and the cell_format argument of as_rtftables().

Examples

# Only the parenthetical cells are aligned; the lone "0" is left as-is.
fmt_count_paren(c("1 (1.2%)", "0", "11 (3.6%)", "108 (35.3%)"))
#> [1] "  1 ( 1.2%)" "0"           " 11 ( 3.6%)" "108 (35.3%)"

# A missing cell lines up under the counts.
fmt_count_paren(c("1 (1.2%)", NA, "108 (35.3%)"), na = "-", nbsp = " ")
#> [1] "  1 ( 1.2%)" "  -        " "108 (35.3%)"