Documentation for Eidos function writeFile, which is a method of
Eidos.
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.
eidos_writeFile(filePath, contents, append, compress)An object of type string or string or logical or logical. Must be of length 1 (a singleton). See details for description.
An object of type string or string or logical or logical. See details for description.
An object of type string or string or logical or logical. Must
be of length 1 (a singleton). The default value is F. See details for
description.
An object of type string or string or logical or logical. Must
be of length 1 (a singleton). The default value is F. See details for
description.
An object of type logical. Return will be of length 1 (a singleton)
Documentation for this function can be found in the official SLiM manual: page NA.
Writes or appends to a file specified by filePath with contents specified by contents, a string vector of lines. If append is T, the write will be appended to the existing file (if any) at filePath; if it is F (the default), then the write will replace an existing file at that path. If the write is successful, T will be returned; if not, F will be returned (but at present, an error will result instead). If compress is T, the contents will be compressed with zlib as they are written, and the standard .gz extension for gzip-compressed files will be appended to the filename in filePath if it is not already present. If the compress option is used in conjunction with append==T, Eidos will buffer data to append and flush it to the file in a delayed fashion (for performance reasons), and so appended data may not be visible in the file until later - potentially not until the process ends (i.e., the end of the SLiM simulation, for example). If that delay if undesirable, buffered data can be explicitly flushed to the filesystem with flushFile(). The compress option was added in Eidos 2.4 (SLiM 3.4). Note that readFile() does not currently support reading in compressed data. Note that newline characters will be added at the ends of the lines in contents. If you do not wish to have newlines added, you should use paste() to assemble the elements of contents together into a singleton string.
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 Eidos:
Eidos,
eidos_abs(),
eidos_acos(),
eidos_all(),
eidos_any(),
eidos_apply(),
eidos_array(),
eidos_asFloat(),
eidos_asInteger(),
eidos_asLogical(),
eidos_asString(),
eidos_asin(),
eidos_assert(),
eidos_atan2(),
eidos_atan(),
eidos_beep(),
eidos_catn(),
eidos_cat(),
eidos_cbind(),
eidos_ceil(),
eidos_citation(),
eidos_clock(),
eidos_cmColors(),
eidos_color2rgb(),
eidos_colors(),
eidos_cor(),
eidos_cos(),
eidos_cov(),
eidos_createDirectory(),
eidos_cumProduct(),
eidos_cumSum(),
eidos_c(),
eidos_date(),
eidos_dbeta(),
eidos_debugIndent(),
eidos_defineConstant(),
eidos_defineGlobal(),
eidos_deleteFile(),
eidos_dexp(),
eidos_dgamma(),
eidos_diag(),
eidos_dim(),
eidos_dmvnorm(),
eidos_dnorm(),
eidos_drop(),
eidos_elementType(),
eidos_exists(),
eidos_exp(),
eidos_fileExists(),
eidos_filesAtPath(),
eidos_findInterval(),
eidos_float(),
eidos_floor(),
eidos_flushFile(),
eidos_format(),
eidos_functionSignature(),
eidos_functionSource(),
eidos_getSeed(),
eidos_getwd(),
eidos_heatColors(),
eidos_hsv2rgb(),
eidos_identical(),
eidos_ifelse(),
eidos_integerDiv(),
eidos_integerMod(),
eidos_integer(),
eidos_isFinite(),
eidos_isFloat(),
eidos_isInfinite(),
eidos_isInteger(),
eidos_isLogical(),
eidos_isNAN(),
eidos_isNULL(),
eidos_isObject(),
eidos_isString(),
eidos_length(),
eidos_license(),
eidos_log10(),
eidos_log2(),
eidos_logical(),
eidos_log(),
eidos_lowerTri(),
eidos_ls(),
eidos_match(),
eidos_matrixMult(),
eidos_matrix(),
eidos_max(),
eidos_mean(),
eidos_min(),
eidos_nchar(),
eidos_ncol(),
eidos_nrow(),
eidos_object(),
eidos_order(),
eidos_paste0(),
eidos_paste(),
eidos_pmax(),
eidos_pmin(),
eidos_pnorm(),
eidos_print(),
eidos_product(),
eidos_qnorm(),
eidos_quantile(),
eidos_rainbow(),
eidos_range(),
eidos_rank(),
eidos_rbeta(),
eidos_rbind(),
eidos_rbinom(),
eidos_rcauchy(),
eidos_rdunif(),
eidos_readCSV(),
eidos_readFile(),
eidos_repEach(),
eidos_rep(),
eidos_rev(),
eidos_rexp(),
eidos_rf(),
eidos_rgamma(),
eidos_rgb2color(),
eidos_rgb2hsv(),
eidos_rgeom(),
eidos_rlnorm(),
eidos_rmvnorm(),
eidos_rm(),
eidos_rnbinom(),
eidos_rnorm(),
eidos_round(),
eidos_rpois(),
eidos_runif(),
eidos_rweibull(),
eidos_sample(),
eidos_sapply(),
eidos_sd(),
eidos_seqAlong(),
eidos_seqLen(),
eidos_seq(),
eidos_setDifference(),
eidos_setIntersection(),
eidos_setSeed(),
eidos_setSymmetricDifference(),
eidos_setUnion(),
eidos_setwd(),
eidos_sin(),
eidos_size(),
eidos_sortBy(),
eidos_sort(),
eidos_source(),
eidos_sqrt(),
eidos_stop(),
eidos_strcontains(),
eidos_strfind(),
eidos_string(),
eidos_strprefix(),
eidos_strsplit(),
eidos_strsuffix(),
eidos_str(),
eidos_substr(),
eidos_sumExact(),
eidos_sum(),
eidos_suppressWarnings(),
eidos_sysinfo(),
eidos_system(),
eidos_tabulate(),
eidos_tan(),
eidos_tempdir(),
eidos_terrainColors(),
eidos_time(),
eidos_trunc(),
eidos_ttest(),
eidos_type(),
eidos_t(),
eidos_unique(),
eidos_upperTri(),
eidos_usage(),
eidos_var(),
eidos_version(),
eidos_whichMax(),
eidos_whichMin(),
eidos_which(),
eidos_writeTempFile()