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

setFilePath(filePath, initialContents, append, compress, sep)

Arguments

filePath

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

initialContents

An object of type null or string. The default value is NULL. See details for description.

append

An object of type logical. Must be of length 1 (a singleton). The default value is F. See details for description.

compress

An object of type null or logical. Must be of length 1 (a singleton). The default value is NULL. See details for description.

sep

An object of type null or string. Must be of length 1 (a singleton). The default value is NULL. See details for description.

Value

An object of type void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or void or logical.

Details

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

Redirects the LogFile to write new rows to a new filePath. Any rows that have been buffered but not flushed will be written to the previous file first, as if flush() had been called. With this call, new initialContents may be supplied, which will either replace any existing file or will be appended to it, depending upon the value of append. New values may be supplied for compress and sep; the meaning of these parameters is identical to their meaning in createLogFile(), except that a value of NULL for these means "do not change this setting from its previous value". In effect, then, this method lets you start a completely new log file at a new path, without having to create and configure a new LogFile object. The new file will be created (or appended) synchronously, with the specified initial contents.

Author

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