outputUsage: SLiM method outputUsage

In rdinnager/slimrlang: Write SLiM Population Genetics Simulation Scripts in R

Description

Documentation for SLiM function outputUsage, which is a method of the SLiM class SLiMSim. Note that the R function is a stub, it does not do anything in R (except bring up this documentation). It will only do anything useful when used inside a slim_block function further nested in a slim_script function call, where it will be translated into valid SLiM code as part of a full SLiM script.

Usage

outputUsage(void)

Arguments

void	An object of type . See details for description.

Details

Output the current memory usage of the simulation to Eidos’s output stream. The specifics of what is printed, and in what format, should not be relied upon as they may change from version to version of SLiM. This method is primarily useful for understanding where the memory usage of a simulation predominantly resides, for debugging or optimization. Note that it does not capture all memory usage by the process; rather, it summarizes the memory usage by SLiM and Eidos in directly allocated objects and buffers. To get the total memory usage of the running process (either current or peak), use the Eidos function usage().

Value

An object of type void.

Copyright

This is documentation for a function in the SLiM software, and has been reproduced from the official manual, which can be found here: http://benhaller.com/slim/SLiM_Manual.pdf. This documentation is Copyright © 2016–2020 Philipp Messer. All rights reserved. More information about SLiM can be found on the official website: https://messerlab.org/slim/

Author(s)

Benjamin C Haller ([e-mail]) and Philipp W Messer ([e-mail])

rdinnager/slimrlang documentation built on June 20, 2020, 8:17 p.m.