Description Usage Arguments Value Examples

Calculates ROI after sorting observations with ROI defined as (Current Value - Start Value) / Start Value

1 |

`x` |
A data frame containing predicted probabilities of a target event and the actual outcome/class. |

`fixed_cost` |
Fixed cost (e.g. of a campaign) |

`var_cost` |
Variable cost (e.g. discount offered) |

`tp_val` |
The average value of a True Positive |

`prob_col` |
The unquoted name of the column with probabilities of the event of interest. |

`truth_col` |
The unquoted name of the column with the actual outcome/class. Possible values are 'Yes' and 'No'. |

A data frame with the following columns:

row = row numbers

pct = percentiles

cum_rev = cumulated revenue

cost_sum = cumulated costs

roi = return on investment

1 2 3 4 5 6 | ```
roi(predictions,
fixed_cost = 1000,
var_cost = 100,
tp_val = 2000,
prob_col = Yes,
truth_col = Churn)
``` |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.