Reference

Lookup & Other Functions

  • Updated

hēRo3 includes a variety of additional functions for performing lookups, working with probabilities, and doing other miscellaneous calculations. A complete listing of these functions and their usage is provided in the table below.

Function

Description

Example

look_up

Look up a value in a table.  Similar to vlookup in Excel.  By default, look_up will only perform exact matching.  To perform a range lookup, set the optional argument "bin" equal to TRUE.

 
look_up(
  my_table, "my_column" = 10,
  value = "value_column"
)

look_up(
  my_table, "my_column" = 10, 
  value = "value_column", bin = T
)
 rescale_prob Rescale a probability defined over a given interval to one defined over a different interval, assuming a constant rate.  Used to define transition probabilities irrespective of cycle length.  
rescale_prob(my_prob, from = 30, to = 1) 
rate_to_prob  Calculate the probability of an event given a rate, the length of the interval, and the duration over which the rate is estimated.  
rate_to_prob(my_rate, to = 365, per = 30) 
dispatch_strategy   Make a formula whose value depends on the strategy. Expects one argument for each strategy with the name of the argument corresponding to the strategy name and the value corresponding to the value for that strategy. 
dispatch_strategy(
  "strategy_a" = 10,
  "strategy_b" = 30,
  "strategy_c" = 100
) 

 

Related articles