SimDesign (version 1.1)

SimFunctions: Skeleton functions for simulations

Description

This function prints skeleton versions of the required functions and work-flow required to run simulations, complete with the correct inputs, class of outputs, and option comments to help with the initial definitions. Use this at the start when defining your simulation.

Usage

SimFunctions(filename = NULL, comments = FALSE, singlefile = FALSE, summarise = TRUE)

Arguments

filename

a character vector indicating whether the output should be saved to two respective files containing the simulation design and the functional components, respectively. Using this option is generally the recommended approach when beginning to write a Monte Carlo simulation

comments

logical; include helpful comments? Default is FALSE

singlefile

logical; when filename is included, put output in one files? When FALSE the output is saved to two separate files containing the functions and design definitions. Default is FALSE

summarise

include summarise function? Default is TRUE

Details

The function SimDesign_functions is deprecated and will be removed in a future release.

Examples

SimFunctions()
SimFunctions(comments = TRUE) #with helpful comments

## Not run: 
# 
# # write output to two files and include helpful comments
# SimFunctions('mysim', comments = TRUE)
# 
# # write output files to a single file without comments
# SimFunctions('mysim', singlefile = TRUE)
# ## End(Not run)