runTransientFunction: Run Transient Function

View source: R/runTransientFunction.R

runTransientFunctionR Documentation

Run Transient Function

Description

Run a function in a transient (non persistent) context.

Usage

runTransientFunction(function_f_1,
                     arguments_l,
                     evaluationMode_o_1,
                     function_return_type_s_1)

Arguments

function_f_1

a single R function

arguments_l

a list of arguments to pass to the function

evaluationMode_o_1

an evaluation mode object. See EvaluationMode

function_return_type_s_1

a string that is a semantic parameter name, to express expected function return type

Value

A list with names

status

a single boolean. Always TRUE when evaluation mode is standard_R_evaluation. Otherwise, will reflect result validity in the chose evaluation mode.

value

the result of the computation, might be a scalar or not, a warning, an error, ...

mode

the evaluation mode used to check the results

function_return_type_check

available if mode is different of standard_R_evaluation

parameter_type_checks

available if mode is type_checking_inforcement

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

See Also

Refer to runFunction.

Examples

##---- typical case ----
em <- EvaluationMode(defineEvaluationModes()[3])
h <- function(x_s) x_s
runTransientFunction(h, list('neonira'), em, 'x_s')
runTransientFunction(h, list(pi), em, 'x_s')
runTransientFunction(h, list(pi), em, 'x_d')

wyz.code.offensiveProgramming documentation built on Sept. 25, 2023, 9:05 a.m.