gadget_sub_dir: Write out a Gadget sub-directory and return the path to it

In inspktrgadget/gadgetSim: Create Gadget replicates for use in simulation studies

Description

This function will create a new directory by the name of sub_dir within the directory specified by path. The address to the new sub-directory is returned.

Usage

gadget_sub_dir(sub_dir, path = NULL)

get_gadget_sub_dir(obj)

is_gadget_sub_dir(obj)

Arguments

sub_dir	Character. Path to the sub-directory you wish to create
path	Optional. Character string of the path of the Gadget model you are working in

Details

gadget_sub_dir is essentially just an easy way to create a sub-directory of the chosen Gadget model for writing model files to. It could be used for writing replicant models files.

Value

A character string of the path to the sub-directory specified in sub_dir

Examples

## Not run: 
path <- system.file(gad_mod_dir, package = "gadgetSim")
gadget_sub_dir("test_model", path = path)

## End(Not run)
gadget_sub_dir()

inspktrgadget/gadgetSim documentation built on May 10, 2019, 9:51 a.m.