outputResults: Save the results

Description Usage Arguments Value

View source: R/outputResults.R

Description

Save the results

Usage

1
outputResults(sEnv = NULL, summarize = T, saveDataFileName = NULL)

Arguments

sEnv

the environment that BSL functions operate in. Default is "simEnv" so use that to avoid specifying when calling functions

summarize

If TRUE a matrix with breeding cycles in rows and replications in columns, with the first set of columns being cycle means and the second set of columns cycle variances. If FALSE a list as long as the number of replications, with each list element containing a list of all simulation objects.

saveDataFileName

NULL or string of the file name to save the simulated data, like "result1_1". A path can be specified, like "simDirectory/result1_1" (in which case "simDirectory" must exist). Default: NULL.

Value

If saveDataFileName is NULL, data is return as an object, else data is saved as a ".rds" file. To examine the data, use the readRDS function.


BreedingSchemeLanguage documentation built on May 2, 2019, 10:17 a.m.