Documentation for SLiM function usage, which is a method of the SLiM
class Community.
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(void)An object of type . See details for description.
An object of type float. Return will be of length 1 (a singleton)
Documentation for this function can be found in the official SLiM manual: page 669.
Return the current memory usage of the simulation. The specifics of what is totalled up should not be relied upon as it 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 see details of this internal memory usage, use the Community method outputUsage(). To get the total memory usage of the running process (either current or peak), use the Eidos function usage().
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/
Other Community:
Community,
createLogFile(),
deregisterScriptBlock(),
genomicElementTypesWithIDs(),
interactionTypesWithIDs(),
mutationTypesWithIDs(),
outputUsage(),
registerEarlyEvent(),
registerFirstEvent(),
registerInteractionCallback(),
registerLateEvent(),
rescheduleScriptBlock(),
scriptBlocksWithIDs(),
simulationFinished(),
speciesWithIDs(),
subpopulationsWithIDs()