robustlmm (version 3.5.0-2)

viewCopyOfSimulationStudy: Access Simulation Study Code

Description

This is a convenience function to make it simple to access the simulation study script files that are shipped with robustlmm.

Usage

viewCopyOfSimulationStudy(
  study = c("sensitivityCurves.R", "consistencyAndEfficiencyDiagonal.R",
    "consistencyAndEfficiencyBlockDiagonal.R", "breakdown.R", "breakdownMC.R",
    "convergence.R", "robustnessDiagonal.R", "robustnessBlockDiagonal.R",
    "robustnessBlockDiagonalExtended.R"),
  destinationPath = getwd(),
  overwrite = FALSE
)

Arguments

study

Name of the script file, partial matching is supported via match.arg.

destinationPath

optional path to directory in which the copy of the script should be created. By default the current working directory is used.

overwrite

logical; should existing destination files be overwritten?

Details

The function creates a copy of the script file that can be safely edited without changing the original file.

Examples

if (FALSE) {
  viewCopyOfSimulationStudy("sensitivityCurves")
}