Modelling output API

[stevencarlislewalker]

Context

Model simulators can generate model outputs. Model simulators have a type, which is determined (at least partially) by the engine of a simulator. This discussion describes a proposed set of generic S3 methods for generating different kinds of outputs. The implemented methods for each type of output will depend on the type of model simulator. A challenge will be to get the signature of each implementation to be as similar as possible to the signature of the generic. The closer these signatures are, the easier it will be for users to swap out engines at the modelling output step.

Generic S3 Methods

• mp_default
• mp_initial
• mp_trajectory(time_steps, quantities)
  • time_steps : number of time steps to simulate and return
  • quantities : names of quantities to return
• mp_final
• mp_rates
• mp_summaries