Documentation for SLiM function openDocument, which is a method of the SLiM class SLiMgui. 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.

openDocument(filePath)

Arguments

filePath

An object of type string. Must be of length 1 (a singleton). See details for description.

Value

An object of type void or void.

Details

Documentation for this function can be found in the official SLiM manual: page 711.

Open the document at filePath in SLiMgui, if possible. Supported document types include SLiM model files (typically with a .slim path extension), text files (typically with a .txt path extension, and opened as untitled model files), and PNG, JPG/JPEG, BMP, and GIF image file formats (typically .png / .jpg / .jpeg / .bmp / .gif, respectively). (Note that in SLiMguiLegacy, PDF files (.pdf) are supported but these other image file formats are not.) This method can be particularly useful for opening images created by the simulation itself, often by sublaunching a plotting process in R or another environment; see section 14.8 for an example.

See also

Other SLiMgui: SLiMgui, pauseExecution()

Author

Benjamin C Haller (bhaller@benhaller.com) and Philipp W Messer (messer@cornell.edu)