| sumstat_file {coala} | R Documentation |
Summary Statistic: Files
Description
This "summary statistic" returns files with the raw results of
the simulation. Multiple files are returned in case coala needs
multiple calls to simulators to simulate the model. These files
do not contain any post processing of the results done by coala,
e.g. feat_unphased and
feat_ignore_singletons.
Usage
sumstat_file(folder)
Arguments
folder |
The path to a folder. The files will be created there. |
Value
A character vector containing the files in order in which they where created.
See Also
To create a demographic model: coal_model
To calculate this statistic from data: calc_sumstats_from_data
Other summary statistics:
sumstat_dna(),
sumstat_four_gamete(),
sumstat_ihh(),
sumstat_jsfs(),
sumstat_mcmf(),
sumstat_nucleotide_div(),
sumstat_omega(),
sumstat_seg_sites(),
sumstat_sfs(),
sumstat_tajimas_d(),
sumstat_trees()
Examples
folder <- tempfile("coala-test")
model <- coal_model(10, 1) +
feat_mutation(5) +
sumstat_file(folder)
simulate(model)$file
unlink(folder, recursive = TRUE) # Clean up