write_subScript {rSHAPE}

This function is used to programatically take vectors of paramters and write suites of R parameter scripts that will form part of a SHAPE experiment that is being built for running. This is a wrapper for writting out the suite of necessary scripts to form a run.

Description

This function is used to programatically take vectors of paramters and write suites of R parameter scripts that will form part of a SHAPE experiment that is being built for running. This is a wrapper for writting out the suite of necessary scripts to form a run.

Usage

write_subScript(func_subScipt, func_outDir, func_inCombos, func_inParms,
  func_maxJobs, func_appLocation, func_commonArgs, func_submitArgs,
  func_remoteLocation, func_passedArgs,
  func_externalStopper = getOption("shape_external_stopFile"),
  func_sepString = getOption("shape_sepString"))

Arguments

func_subScipt

This is the template script that needs to be replicated

func_outDir

This is the filepath directory where output should be placed

func_inCombos

This is the combinations of parameters that are to be used in the experiment.

func_inParms

# These are additional parameters to be implemented in writing out combinations.

func_maxJobs

This is the maximum number of individual R jobs that should be called at once by the shell submission scripts, it can affect both local and remote server calls.

func_appLocation

This is the filepath for R so that batch mode runs can be called.

func_commonArgs

These are common arguments important when running the batch mode

func_submitArgs

These are common arguments important when submitting the batch mode

func_remoteLocation

This is a remote server location where an experiment built is to be run it affects the filepathing called by submission scripts and the associated batch mode runs performed.

func_passedArgs

These are arguments passed through this wrapper to inner functions.

func_externalStopper

This is a file which exists as a flag for stopping SHAPE from trying to create additional replicates.

func_sepString

This is the common string used to collapse information.

Value

A character string that should indicate the experiment has been created. Otheriwse this has failed.

Note

There is no example as this cannot work outisde of a runSHAPE call, it requires data produced by the simulation experiment.