R/plotMDFR.Bubbles.R

In wStockhausen/rCompTCMs: Package to compare TCSAM02, rsimTCSAM, and TCSAM2013 model runs

#'
#' @title Create or add to a circle plot of age or size comp.s.
#'
#' @description Creates or adds to a circle plot of age or size comp.s.
#'
#'@param x - column name for x-axis values
#'@param y - column name for y-axis values
#'@param value.var - column name for values to aggregate (value.var in cast)/plot as circles
#'@param agg.formula - aggregation formula (left-hand side of cast formula)
#'@param agg.function - aggregation function (fun.aggregate in cast)
#'@param ... - further arguments passed to aggregating function
#'@param colour - column name to which colour aesthetic is mapped
#'@param facet_grid - faceting formula
#'@param units - units for bubble size scale
#'@param xlab - x axis label
#'@param ylab - y axis label
#'@param title - plot title
#'@param alpha - transparency level
#'@param maxBubbleSize - max bubble size
#'@param useColourGradient - flag (T/F) to use a color gradient for bubble color
#'@param guideTitleColour - title for colour guide
#'@param showPlot - flag to show plot immediately
#'
#'@return ggplot2 object
#'
#'@details uses \code{reshape2} package.
#'
#'@import ggplot2
#'@import reshape2
#'@importFrom wtsPlots getStdTheme
#'
#'@export
#'
plotMDFR.Bubbles<-function(mdfr,
                           x=NULL,
                           y=NULL,
                           value.var='val',
                           agg.formula=NULL,
                           agg.function=sum,
                           ...,
                           colour=NULL,
                           facet_grid=NULL,
                           units="",
                           xlab="",
                           ylab="",
                           title="",
                           alpha=0.5,
                           maxBubbleSize=6,
                           useColourGradient=FALSE,
                           guideTitleColour="",
                           showPlot=FALSE
                           ){
    #cast melted dataframe
    if (!is.null(agg.formula)){
        #aggregate using formula
        form<-paste(agg.formula,".",sep="~")
        mdfr<-reshape2::dcast(mdfr,form,fun.aggregate=agg.function,value.var=value.var);
    } else {
        #rename value.var column to '.'
        nms<-colnames(mdfr);
        nms[nms==value.var]<-'.';
        colnames(mdfr)<-nms;
    }

    #plot resulting dataframe
    if (sum(mdfr[["."]])==0) mdfr[["."]][1]<-1.0e-10;
    p <- ggplot(aes_string(x=x,y=y,size='.',colour=colour),data=mdfr);
    p <- p + scale_size_area(max_size=maxBubbleSize);
    if (useColourGradient) p <- p + scale_color_gradientn(colours=wtsUtilities::createColorPalette('jet',100,alpha=alpha))
    p <- p + geom_point(alpha=alpha);
    if (!is.null(xlab))     p <- p + xlab(xlab);
    if (!is.null(ylab))     p <- p + ylab(ylab);
    if (!is.null(title))    p <- p + ggtitle(title);
    if (!is.null(facet_grid)) p <- p + facet_grid(facet_grid);
    p <- p + guides(size=guide_legend(title=units,override.aes=list(alpha=1.0),order=1));
    if (!is.null(guideTitleColour)) {
        if (useColourGradient) {
            p <- p + guides(colour=guide_colorbar(guideTitleColour,alpha=1.0,order=2));
        } else {
            p <- p + guides(colour=guide_legend(guideTitleColour,override.aes=list(alpha=1.0,size=6),order=2));
        }
    }
    p = p + wtsPlots::getStdTheme();
    if (showPlot) print(p);

    return(p)
}