set_var_sexgender {bage} | R Documentation |
Specify Sex or Gender Variable
Description
Specify which variable (if any) represents sex or gender.
Functions mod_pois()
, mod_binom()
,
and mod_norm()
try to infer the sex/gender variable
from variable names, but do not always get it right.
Usage
set_var_sexgender(mod, name)
Arguments
mod |
An object of class |
name |
The name of the sex or gender variable. |
Details
In an R formula
, a 'variable' is different
from a 'term'. For instance,
~ gender + region + gender:region
contains variables gender
and region
,
and terms gender
, region
, and gender:region
.
If set_var_sexgender()
is applied to
a fitted model, set_var_sexgender()
unfits
the model, deleting existing estimates.
Value
A "bage_mod"
object
See Also
-
set_var_age()
Set age variable -
set_var_time()
Set time variable -
is_fitted()
Test whether model is fitted internally, bage uses
poputils::find_var_sexgender()
to locate sex or gender variablesinternally, bage uses
poputils::find_label_female()
to locate female categories within a sex or gender variableinternally, bage uses
poputils::find_label_male()
to locate male categories within a sex or gender variable
Examples
## rename 'sex' variable to something unexpected
injuries2 <- nzl_injuries
injuries2$biological_sex <- injuries2$sex
## mod_pois does not recognize sex variable
mod <- mod_pois(injuries ~ age * biological_sex + year,
data = injuries2,
exposure = popn)
mod
## so we set the sex variable explicitly
mod |>
set_var_sexgender(name = "biological_sex")