upgradeSim: Upgrade MizerSim object from earlier mizer versions

In mizer: Dynamic Multi-Species Size Spectrum Modelling

Upgrade MizerSim object from earlier mizer versions

Description

Occasionally, during the development of new features for mizer, the MizerSim class or the MizerParams class gains extra slots. MizerSim objects created in older versions of mizer are then no longer valid in the new version because of the missing slots. You need to upgrade them with

sim <- upgradeSim(sim)

where sim should be replaced by the name of your MizerSim object.

Usage

upgradeSim(sim)

Arguments

sim	An old MizerSim object to be upgraded

Details

This function adds the missing slots and fills them with default values. It calls upgradeParams() to upgrade the MizerParams object inside the MizerSim object. Any object from version 0.4 onwards can be upgraded.

Value

The upgraded MizerSim object

Backwards compatibility

The internal numerics in mizer have changed over time, so there may be small discrepancies between the results obtained with the upgraded object in the new version and the original object in the old version. If it is important for you to reproduce the exact results then you should install the version of mizer with which you obtained the results. You can do this with

remotes::install_github("sizespectrum/mizer", ref = "v0.2")

where you should replace "v0.2" with the version number you require. You can see the list of available releases at https://github.com/sizespectrum/mizer/tags.

If you only have a serialised version of the old object, for example created via saveRDS(), and you get an error when trying to read it in with readRDS() then unfortunately you will need to install the old version of mizer first to read the params object into your workspace, then switch to the current version and then call upgradeParams(). You can then save the new version again with saveRDS().

mizer documentation built on April 26, 2023, 5:12 p.m.