R/plotABC.R

In wStockhausen/rTCSAM2013: Functions to run and plot output from TCSAM2013 models.

#'
#'@title Function to plot ABC and OFL calculations from calcABC(...)
#'
#'@description This function plots ABC and OFL from TCSAM2013 projection model output.
#'
#'@param x - empirical cdf of OFL
#'@param OFL - estimated OFL
#'@param ABC.pstar - ABC based on pstar method
#'@param ABC.buff  - ABC based on buffer method
#'@param buffer - buffer used for ABC.buff
#'@param title - title for plot
#'@param xlims - range for x-axis in plot
#'@param save - flag (T/F) to save OFL plot to "oflPlot.png".
#'
#'@import graphics
#'
#'@details None.
#'
#'@export
#'
plotABC<-function(x,OFL,ABC.pstar,ABC.buff,buffer=0.2,title=NULL,xlims=NULL,save=FALSE){
    
    if (save) {
        png("oflPlot.png",width=800,height=500);
        on.exit(dev.off());
    }
    if (is.null(xlims)) xlims<-range(quantile(x,probs=c(0.005,0.995)),ABC.buff-2,na.rm=TRUE);
    plot(x,xlab="estimated OFL (1000's t)",ylab="empirical cdf",main="",lwd=2,xlim=xlims);
    abline(v=OFL,col="red",lwd=3)
    text(1.01*OFL,0.95,"OFL",col='red',adj=0)
    
    abline(v=ABC.pstar,col="blue",lwd=3,lty=2)
    text(ABC.pstar,0.85,"ABC\np*",col='blue',adj=1.01)
    
    abline(v=ABC.buff,col="green",lwd=3,lty=2)
    text(ABC.buff,0.85,paste("ABC\n",100*buffer,"%",sep=''),col='green',adj=1.01)
    
    if (!is.null(title)) mtext(title,side=3,adj=0.1);
}