objSize.simList: Object size for 'simList'

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Object size for simList

Description

Recursively, runs reproducible::objSize() on the simList environment, so it estimates the correct size of functions stored there (e.g., with their enclosing environments) plus, it adds all other "normal" elements of the simList, e.g., objSize(completed(sim)). The output is structured into 2 elements: the sim environment and all its objects, and the other slots in the simList (e.g., events, completed, modules, etc.). The returned object also has an attribute, "total", which shows the total size.

Usage

## S3 method for class 'simList'
objSize(x, quick = TRUE, ...)

Arguments

x	An object
quick	Logical. If FALSE, then an attribute, "objSize" will be added to the returned value, with each of the elements' object size returned also.
...	Additional arguments (currently unused), enables backwards compatible use.

Value

an estimate of the size of the object, in bytes.

Examples

a <- simInit(objects = list(d = 1:10, b = 2:20))
objSize(a)
utils::object.size(a)

SpaDES.core documentation built on June 22, 2024, 10:32 a.m.