get_tzar_pkg_templates: get template files for setting up to run tzar emulation

In langfob/tzar: Package for emulating running tzar tool from inside R

Description

This is a convenience function to run one time at the start of using tzar emulation on a project. Tzar requires a model.R file and tzar emulation requires a file like tzar_main.R to call the user's application code as well as a tzar_emulation.yaml file to specify emulation control parameters. The tzar package provides a template for each of these files to make it as simple as possible to do emulation.

Usage

get_tzar_pkg_templates(target_dir = ".", running_inside_a_package = TRUE)

Arguments

target_dir	Path of directory where template files are to be deposited
running_inside_a_package	Boolean flag set to TRUE if emulation will be done inside a package build and FALSE otherwise

Details

One catch in using the templates is that when development is being done as part of building a package, the model.R file can't be called model.R. This is because when R builds a package, it runs all ".R" files in the package's R directory since they are assumed to do nothing but define functions. Since model.R runs experiments instead of defining functions, this will not work inside a package build. Tzar emulation gets around this by disguising the name of model.R as model.R.tzar and then renaming it to model.R just before a tzar run, then renaming it back to model.R.tzar after the emulation run.

To cover this situation, set the running_inside_a_package argument to TRUE. If tzar emulation is to be done in a normal R programming situation that doesn't involve a package build, then it's fine for model.R to keep its name as is and set running_inside_a_package to FALSE.

Note that for safety, the copying operations done in this function will not overwrite any existing file with the same name in the target directory.

Examples

## Not run: 
    #  Copy template files to current directory for use in
    #  developing a package.
get_tzar_pkg_templates ()

    #  Copy template files to R subdirectory for use in normal
    #  R development outside of developing a package.
get_tzar_pkg_templates ("./R", FALSE)

## End(Not run)

langfob/tzar documentation built on May 20, 2019, 7:56 p.m.