quickcode (version 1.0.6)

track_func: Track Function Usage and Performance

Description

Up count the number of times a particular function is called. This function tracker is a higher-order function or decorator that wraps around other functions to monitor and record their execution patterns, including metrics like call frequency, execution time, argument patterns, and return values. It acts as a transparent layer that doesn't modify the original function's behavior but collects valuable metadata about its usage.

Usage

track_func(output.dest = "output_tracking.csv")

Value

the numeric count of a function usage

Arguments

output.dest

destination of csv file to store outputs

Examples

if (FALSE) {
library(quickcode)
# Track usage of type2 and type1 functions
store.usage.file <- tempfile()
type5 <- function(x) type2(x)
type4 <- function(x) type3(x)
type3 <- function(x) type1(x)
type1 <- function(x) {
  mean(x)
  sd(x)
  track_func(store.usage.file)
}
type2 <- function(x) {
  type1(x)
  track_func(store.usage.file)
}

# add usage counts to store.usage.file
type1(number(10))
type2(number(10))
type3(number(10))
type4(number(10))
type5(number(10))

# check the stored function usage file
print(read.csv(store.usage.file))
}