R/CalcEuroLotteryPnL.R

In sa-ccr/Trading: CCR, Advanced Correlation & Beta Estimates, Betting Strategies

#' Calculates the PnL for a pay out structure created during backtesting 
#' @title  PnL calculation for EuroMillions/EuroJackpot backtesting
#' @param backtested_results The EuroMillions/EuroJackpot results backtested against the user input 
#' @param plot_results (Optional) If TRUE, the P&L historical graphs are plotted, default FALSE 
#' @return PnL figures
#' @export
#' 
#' @author Tasos Grivas <tasos@@openriskcalculator.com>
#' @examples
#' 
#' euromillions_results = EuroMillionsResults()
#' user_input = c(10,20,30,40,50,5,10)
#' backtested_results = EuroLotteryBacktesting(euromillions_results, '2005-01-01', user_input)
#' pnl_result = CalcEuroLotteryPnL(backtested_results, plot_results = TRUE)

CalcEuroLotteryPnL <- function(backtested_results, plot_results = FALSE)  {
  
  payout_categories =c("two","twoone","onetwo","three","threeone","twotwo","four",
                       "threetwo","fourone","fourtwo","five","fiveone","fivetwo")
  payout_structure = data.frame(seq(0,length(payout_categories)))
  payout_prizes = c(0,4,6,7,9,11,14,39,57,120,1299,20851,200738,10000000)
  payout_structure = data.table(cbind(payout_structure, payout_prizes))
  names(payout_structure)[1]='winning_scale'
  
  backtested_results = setkey(payout_structure,"winning_scale")[setkey(backtested_results,"winning_scale")]
  backtested_results = backtested_results[order(dates_parsed)]
  backtested_results[,cum_profit:=cumsum(payout_prizes)]
  backtested_results$cost = 2.5
  backtested_results[,cum_cost := cumsum(cost)]
  backtested_results[,final_pnl:=cum_profit-cum_cost]
  
  if(plot_results)
  {
    a=ggplot()+
      geom_line(data=backtested_results,aes(y=final_pnl,x= dates_parsed,colour="Total P&L"),size=1 )+
      geom_line(data=backtested_results,aes(y=-cum_cost,x= dates_parsed,colour="Total Cost"),size=1) +
      geom_line(data=backtested_results,aes(y=cum_profit,x= dates_parsed,colour="Total Profit"),size=1) +
      scale_color_manual(name = "P&L Graphs", values = c("Total P&L" = "darkblue", "Total Cost" = "red", "Total Profit" = "green"))+xlab("Dates")+ylab("Cumulative P&L Results")
    print(a)
  }
  
  return(backtested_results)
  
}