simulationFinished: SLiM method simulationFinished

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

Description

Documentation for SLiM function simulationFinished, 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

simulationFinished(void)

Arguments

void	An object of type . See details for description.

Details

Declare the current simulation finished. Normally SLiM ends a simulation when, at the end of a generation, there are no script events or callbacks registered for any future generation (excluding scripts with no declared end generation). If you wish to end a simulation before this condition is met, a call to simulationFinished() will cause the current simulation to end at the end of the current generation. For example, a simulation might self- terminate if a test for a dynamic equilibrium condition is satisfied. Note that the current generation will finish executing; if you want the simulation to stop immediately, you can use the Eidos method stop(), which raises an error condition.

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.