passthru_fun: Represents Pass Through Function We Wish to Condense In Call...

In brodieG/treeprof: Visualize Rprof Results as a Tree

Description

Prime example is 'try', which generates a whole bunch of calls that are not really useful in trying to figure out what's going on in the profile.

Usage

passthru_fun(enter, exit, dont.exit.if)

Arguments

enter	character 1 length the name of the pass through function
exit	character 1 length the name of the function that then evaluates the rest of the code
depth	integer 1 length the distance between enter and exit in terms of levels in the call stack; this is necessary to deal with potentially nested pass through functions; note this includes the entry and exit levels, so if the entry and exit levels are 1 apart, the depth should be 2, not 1

Details

These are referred to as pass through functions because they wrap around other code, so we're interested in seeing what the rest of the code is doing

Value

a passthru_fun class S3 object

brodieG/treeprof documentation built on Nov. 11, 2021, 1:36 a.m.