Compute doses ratio for imputation

Calculate the ratios to be used for missing dose imputation using the target-reference pairs in the sample_pair argument.

Usage

compute_doses_ratio(
  ri_data,
  live_births = deprecated(),
  ...,
  sample_pair = NULL,
  dose_names = deprecated()
)

Arguments

ri_data

[data.frame] Routine immunization data in the format required by impute_missing_doses(). Missing values are permitted only in vaccine-dose columns.

live_births

[data.frame] Number of babies born in a given admin unit in a given year. This argument is deprecated as of version 0.2.0. Please include the live births data in the routine immunization data (ri_data) instead with its column named according to birth argument in config_pviem().

...

Forces optional arguments to be passed by name and allows for future extensions without breaking existing code. Must be empty.

sample_pair

As defined in impute_missing_doses().

dose_names

[character] . A character vector of dose column names to compute the ratios for. This argument is deprecated as of version 0.2.0. Please provide the sample_pair argument or ensure that ri_data is validated to have the appropriate dose columns.

Value

[data.frame] The ratios for each dose specified in sample_pair names. The columns are the same as in ri_data with the addition of the birth column defined in config_pviem().

Note

By dose, we mean the identifier of each given dose for each vaccine which is the vaccine name and the dose number concatenated as described in the ri_data argument.

See also

impute_missing_doses()