return.multiple: return.multiple

In RLogik/rbettersyntax: Simpler Syntax for R

Description

Handles functions with multiple outputs better without messy intermediate list-objects.

Usage

return.multiple(map, f)(<INPUTARGS>)

Arguments

map	A list mapping external names to local-names of return-entities in output of f.
f	Function which returns a list-objet as output.
<INPUTARGS>	Input arguments for f.

Examples

## Not run: 
infos <- function(firstname='',surname='',age=0) {
	underage <- (age < 18);
	fullname <- gsub('^\\s+|\\s+$', '', print0(firstname,' ',surname));

	return(list(
		voter = !underage,
		fullname = fullname,
		validname = !(fullname == '')
	));
};
return.multiple(list(valid='validname', isvoter='voter'), f)(firstname='Richard', surname='Feynman', age=100);

# equivalent to:
obj <- f(firstname='Richard', surname='Feynman', age=100);
valid <- obj$validname;
isvoter <- obj$voter;
 
## End(Not run)
## Not run: 
f <- function(<INPUTARGS>) {
	·
	·
	·
	return(list(
		localoutput1 = <RETURN-OUTPUT1>,
		localoutput2 = <RETURN-OUTPUT2>,
		·
		·
	));
};
 ·
 ·
 ·
return.multiple(list(var1=localoutput1, var2=localoutput2, ...), f)(<INPUTARGS>);

# equivalent to:
obj <- f(<INPUTARGS>);
var1 <- obj$localoutput1;
var2 <- obj$localoutput1;
 ·
 ·
 ·
 
## End(Not run)

RLogik/rbettersyntax documentation built on Aug. 1, 2020, 10:44 p.m.