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, to = 1, from = 30)
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) 
by_group(...) Make a formula whose value depends on the group. Expects one argument for each group with name of the argument corresponding to group name and value corresponding to value for that group. Please note that by_group(...) cannot take survival distributions as inputs. 
by_group(
  "group_a" = 10,
  "group_b" = 30, 
  "group_c" = 100
)
by_strategy(...)  Make a formula whose value depends on the strategy. Expects one argument for each strategy with name of the argument corresponding to strategy name and value corresponding to value for that strategy. 
by_strategy(
  "strategy_a" = 10,
  "strategy_b" = 30,
  "strategy_c" = 100
) 

 

Related articles