Skip to contents

Create a procr_varformat for the Total

Source: R/varformat_new.R
total_format.Rd

This convenience function creates a procr_varformat with one row that represents all available rows. It can be used when just one Total value should be displayed for multiple procr_varformat.

Usage

total_format(label = "Total", name = "Variable")

tf(label = "Total", name = "Variable")

Arguments

label

Label for the Total value. By default, "Total".

name

Name of the format, only used internally. By default, "Object".

Value

A procr_varformat object.

See also

new_format() new_format_asis()

Examples

total_format(label = "Total")
#> Variable                                             code                       
#> ╲╴Total                                              TRUE                       
#>