validate_gen_u5_ax: Helper for 'gen_u5_ax' validations

View source: R/gen_u5_ax.R

validate_gen_u5_axR Documentation

Helper for gen_u5_ax validations

Description

Helper for gen_u5_ax validations

Usage

validate_gen_u5_ax(dt, id_cols, param_cols)

Arguments

dt

[data.table()]
Columns:

  • 'age_start' with values 0 (for under-1) and 1 (for 1-4). Other ages permitted but will result in NA output for ax or unchanged ax if ax in input dt.

  • 'age_end' with values 1 (for under-1) and 5 (for 1-4).

  • 'sex' where values must be 'male', 'female', or 'both'

  • 'mx' for mortality rate

  • All additional columns from 'id_cols'

id_cols

[character()]
Columns that uniquely identify observations in dt. Must include 'age_start', 'age_end', and 'sex'.

param_cols

[character()] "mx" for gen_u5_ax_from_mx and "qx" for gen_u5_ax_from_qx


ihmeuw-demographics/demCore documentation built on Feb. 24, 2024, 11:05 p.m.