CARMS (version 1.0.1)

examples: Handle the installed examples in a carms project.

Description

This function delivers, a list of the examples, will "run" (source) an example script, copy an installed example to the working directory, or display the examples directory location.

Usage

examples(action="list", file=NULL, package="CARMS")

Value

For the "list" action a dataframe with single column named "examples". For the "dir" action a string providing the examples directory reference. For a successful "run" action a 1 will be returned. Of course the diagram and plot will also display. For a successful "copy" action TRUE will be returned.

Arguments

action

A string indicating how the function is to operate. "list", "run", "copy" and "dir" are expected arguments.

file

An integer representing the file row in the "list" dataframe, or string providing the exact file name desired to be sourced.

package

A string naming the package.

Details

This function is provided as a crutch for users of the CARMS package who may have no prior experience with R. To them a sourced script has been "run". It is also desirable for them to copy example scripts into their working directory for examination and edit, rather than accessing the examples (and potentially modifying them) from the installed examples directory.

References

Jan Pukite and Paul Pukite (1998), "Modeling for Reliability Analysis", IEEE Press, New York

William J. Stewart (1994), "Introduction to the numerical solution of Markov chains", Princeton University Press, Princeton

Examples

	examples() # will return a dataframe listing the available examples
	examples("dir") # will return the installed examples directory reference.
	# \donttest{
	examples("run", 1) # will source the first example
	# }