format_age_month: Create consistent, complete one-month age groups

In johnrbryant/demprep: Prepare Demographic Data

Description

Given a vector of age group labels, create a factor that contains levels for all ages between break_min and break_max. The labels may contain an open age group, ie an age group with no upper limit. Apart from the open age group, all the age groups have a width of one month.

Usage

format_age_month(x, break_min = 0, break_max = 1200, open_last = TRUE)

Arguments

x	A vector of age group labels.
break_min	An integer or NULL. Defaults to 0.
break_max	An integer or NULL. Defaults to 1200.
open_last	Whether the final age group has no upper limit. Defaults to TRUE.

Details

Even when an age group between break_min and break_max is not included in x, factor_month still creates a level for it.

If break_min or break_max is set to NULL, rather than to a specific value, then format_age_year finds the narrowest range that accommodates the data.

If x contains NA, then the levels of the factor created by format_age_month also contain NA.

Value

A factor with the same length as x.

See Also

Other functions for creating age groups are

• format_age_year

• format_age_multi

• format_age_lifetab

• format_age_births

• format_age_custom

• format_age_quarter

date_to_age_month calculates ages from dates.

Examples

format_age_month(x = c(22, 0, 300))

format_age_month(x = c("3", NA, "12", "1400+"))

## specify highest age group
format_age_month(x = c("3", "12", "1400+"),
                 break_max = 24)

## let lowest age group be determined by the data
format_age_month(x = c("3", "12", "1400+"),
                 break_min = NULL,
                 break_max = 24)

## make final age group closed
format_age_month(x = c("3", "12"),
                 break_min = NULL,
                 break_max = 24,
                 open_last = FALSE)

johnrbryant/demprep documentation built on Dec. 31, 2021, 11:58 a.m.