Names of the functions to estimate rates and example in the documentation do not correspond

[liliana-calderon]

After a change in the name of the functions to estimate the rates, now called estimate_fertility_rates() and estimate_mortality_rates(),
when calling the R documentation, in the usage we get

estimate_fertility_rates(
opop,
final_sim_year,
year_min,
year_max,
year_group = 5,
age_min_fert = 15,
age_max_fert = 50,
age_group = 5
)

But in the example:

Retrieve age-specific fertility rates

asfr <- get_asfr_socsim(opop = opop,
final_sim_year = 2021,
year_min = 1750,
year_max = 2020,
year_group = 5,
age_min_fert = 10,
age_max_fert = 55,
age_group = 5)

It should be better to unify the terms: estimate instead of retrieve and get.
In the explanation of the arguments, age_min_fert has the explanation for age_max_fert (numeric. Upper-bound age of female reproductive period) It should be Lower-bound. Also, age_max_fert is missing.

In the case of mortality, we have the same problem:

In the usage, it uses the term estimate
estimate_mortality_rates(
opop,
final_sim_year,
year_min,
year_max,
year_group,
age_max_mort,
age_group
)

But in the example it shows Retrieve and get

Retrieve age-specific mortality rates

asmr <- get_asmr_socsim(opop = opop,
final_sim_year = 2021,
year_min = 1750,
year_max = 2020,
year_group = 5,
age_max_mort = 110,
age_group = 5)

[tomthe]

Okay, I agree. So I will change this all to estimate_mortality_rates and estimate_fertility_rates where appropriate. retrieve_kin will remain retrieve_kin.