Based on the chosen mortality law (or a custom law), this function retrieves the default starting parameters, the model information table, and whether the age vector should be scaled before fitting.
addDetails(law, custom.law = NULL, parS = NULL)A list with components:
Internal law name (e.g., "custom.law" for user-supplied functions).
Starting parameter values for the optimisation.
Model information data frame (from availableLaws)
or "Custom Mortality Law" for user-defined models.
Logical; whether the age vector should be re-scaled
(x = x - min(x) + 1) before fitting.
The name of the mortality law to be used (e.g., "gompertz",
"makeham"). Run availableLaws to see all options.
A user-defined function for fitting a model not included
in the package. The function must accept arguments x (age vector)
and par (named parameter vector) and return a list containing at
least an element named hx (the hazard or force of mortality). See
the examples below.
Optional starting parameter values for the optimisation. If
NULL, sensible defaults are automatically chosen via
bring_parameters.