pxmake (version 0.19.0)

px_add_totals: Add total levels to variables

Description

Adds a total level, which is the sum of the figures for all other levels of the variable.

The default name of the total level is 'Total', unless px_elimination is set, in which case the elimination code is used.

Usage

px_add_totals(x, value, na.rm = TRUE, validate)
# S3 method for px
px_add_totals(x, value, na.rm = TRUE, validate = TRUE)

Value

A px object

Arguments

x

A px object

value

A character vector of variables to add total levels to.

na.rm

Optional. Logical. If TRUE, NAs are removed before summing.

validate

Optional. If TRUE a number of validation checks are performed on the px object, and an error is thrown if the object is not valid. If FALSE, the checks are skipped, which can be usefull for large px objects where the check can be time consuming. Use px_validate() to manually preform the check.

See Also

px_elimination

Examples

# Create small px object example
x0 <- px(subset(population_gl, age == "65+"))
px_data(x0)

# Add total level to one variable
x1 <- px_add_totals(x0, "gender")
px_data(x1)

# Add total level to multiple variables
x2 <- px_add_totals(x0, c("gender", "age"))
px_data(x2)

# The name of the total level can be changed with px_elimination()
x3 <-
  x0 |>
  px_elimination("T") |>
  px_add_totals("gender")

px_data(x3)