R/ggCatepillar.R

In ggiraphExtra: Make Interactive 'ggplot2'. Extension to 'ggplot2' and 'ggiraph'

#' Paste character vectors separated by colon
#'
#'@param ... Arguments passed on to paste()
#'@export
pastecolon=function(...){
        paste(...,sep=":")
}

#' Make an interactive catepillar plot
#'
#'@param data a data.frame
#'@param mapping Set of aesthetic mappings created by aes or aes_.
#'@param interactive A logical value. If TRUE, an interactive plot will be returned
#'@param digits An integer indicating the number of decimal places
#'@param errorbar which value is displayed with errorbar :"se" or "sd"
#'@param flip Logical. If TRUE, coord_flip() function is used to make a horizontal plot
#'@param use.label Logical. Whether or not use column label in case of labelled data
#'@param use.labels Logical. Whether or not use value labels in case of labelled data
#'@importFrom ggplot2 geom_errorbar
#'@export
#'@return An interactive catepillar plot
#'@examples
#'require(moonBook)
#'require(ggiraph)
#'require(ggplot2)
#'ggCatepillar(acs,aes(Dx,age,color=HBP))
#'ggCatepillar(acs,aes(c(Dx,sex),age,color=HBP),interactive=TRUE,flip=TRUE,use.labels=FALSE)
#'ggCatepillar(acs,aes(age,height,color=sex),errorbar=FALSE,interactive=TRUE)
ggCatepillar=function(data,mapping,errorbar="se",interactive=FALSE,digits=1,flip=FALSE,use.label=TRUE,use.labels=TRUE){

        # data=acs;mapping=aes(c(Dx,sex),age,color=HBP);interactive=FALSE;digits=1;errorbar="se";flip=TRUE
        # use.label=TRUE;use.labels=TRUE
        xvar<-yvar<-groupvar<-colourvar<-NULL
        xvar=getMapping(mapping,"x")
        yvar=getMapping(mapping,"y")

        if(is.null(xvar)|is.null(yvar)) warning("Both x and y aesthetics are should be mapped")
        (groupname=setdiff(names(mapping),c("x","y")))
        if(length(groupname)>0) (groupvar=getMapping(mapping,groupname))
        name=names(mapping)

        xlabels<-ylabels<-filllabels<-colourlabels<-xlab<-ylab<-colourlab<-filllab<-NULL
        for(i in 1:length(name)){
                (varname=paste0(name[i],"var"))
                labname=paste0(name[i],"lab")
                labelsname=paste0(name[i],"labels")

                temp=getMapping(mapping,name[i])
                # if(length(temp)>1) temp=temp[-1]
                assign(varname,temp)
                x=eval(parse(text=paste0("data$",eval(parse(text=varname)))))
                assign(labname,attr(x,"label"))
                assign(labelsname,sjlabelled::get_labels(x))
        }

        # if(length(xvar)>1) xvar<-xvar[-1]

        df<-data
        A=yvar
        B=groupvar
        C=xvar

        if(is.null(B)){
                dat=summarySE(df,A,C)
                dat$tooltip="all"
                if(length(C)==1) {
                        dat$label=paste0(C,": ",dat[[C]],"<br>",A,": ",round(dat[[A]],digits),
                                 "<br>sd: ",round(dat$sd,digits),"<br>se: ",round(dat$se,digits))
                } else {
                        dat$label=paste0(A,": ",round(dat[[A]],digits),
                                 "<br>sd: ",round(dat$sd,digits),"<br>se: ",round(dat$se,digits))
                }

        } else {
                dat=summarySE(df,A,c(B,C))
                dat[[B]]=factor(dat[[B]])
                dat$tooltip=dat[[B]]
                if(length(C)==1) {
                        dat$label=paste0(B,": ",dat[[B]],"<br>",C,":",dat[[C]],"<br>",A,": ",round(dat[[A]],digits),
                                  "<br>sd: ",round(dat$sd,digits),"<br>se: ",round(dat$se,digits))
                } else {
                        dat$label=paste0(B,": ",dat[[B]],"<br>",A,": ",round(dat[[A]],digits),
                                      "<br>sd: ",round(dat$sd,digits),"<br>se: ",round(dat$se,digits))
                }

        }
        if(length(C)>1){
                temp=Reduce(paste0,C)
                dat[[temp]]=Reduce(pastecolon,dat[C])
                C=temp
                dat[[C]]=factor(dat[[C]])
        }

        dat

        #dat$tooltip=dat[[B]]
        #dat$label=paste0(dat[[B]],"<br>",dat[[C]],"<br>",round(dat[[A]],digits))
        dat$id=1:nrow(dat)

        #print(dat)

        if(class(dat[[C]])%in% c("numeric","integer")) {
                mywidth=max(dat[[C]])/80
        } else mywidth=0.2
        #mywidth

         if(is.null(B)) {
                 p<-ggplot(data=dat,aes_string(x=C,y=A,group=1,colour=C))+xlab(Reduce(pastecolon,C))

         } else p<-ggplot(data=dat,aes_string(x=C,y=A,group=B,colour=B))


        p<-p+ geom_path_interactive(aes_string(tooltip="tooltip",data_id="id"),position=position_dodge(width=mywidth))+
                geom_point_interactive(aes_string(tooltip="label",data_id="id"),size=4,position=position_dodge(width=mywidth))
        p
        if(errorbar=="se"|errorbar=="sd") p<-p+eval(parse(text=paste0("geom_errorbar(aes(ymin=",A,"-",errorbar,",ymax=",
                                    A,"+",errorbar,"),width=",mywidth,",
                                    position=position_dodge(width=mywidth))")))
        if(flip) p<-p+coord_flip()

        if(use.labels) {
                if(length(xvar)==1){
                if(!is.null(xlabels)) {
                        if(is.numeric(data[[xvar[1]]])) p<-p+scale_x_continuous(breaks=1:length(xlabels),labels=xlabels)
                        else p<-p+scale_x_discrete(labels=xlabels)
                }
                }
                if(!is.null(ylabels))  p<-p+scale_y_continuous(breaks=1:length(ylabels),labels=ylabels)
                if(!is.null(filllabels)) p=p+scale_fill_discrete(labels=filllabels)
                if(!is.null(colourlabels)) {
                        if(!is.numeric(data[[colourvar]])) p=p+scale_color_discrete(labels=colourlabels)

                }

        }
        if(use.label){
                if(!is.null(xlab)) p<-p+labs(x=xlab)
                if(!is.null(ylab)) p<-p+labs(y=ylab)
                if(!is.null(colourlab)) p<-p+labs(colour=colourlab)
                if(!is.null(filllab)) p<-p+labs(fill=filllab)
        }
        p
        #p<-my_theme(p)
        #p<-p+theme(legend.position="none")
        if(interactive){
                tooltip_css <- "background-color:white;font-style:italic;padding:10px;border-radius:10px 20px 10px 20px;"
                #hover_css="fill-opacity=.3;cursor:pointer;stroke:gold;"
                hover_css="r:4px;cursor:pointer;stroke-width:6px;"
                selected_css = "fill:#FF3333;stroke:black;"

                p<-girafe(ggobj=p)
                p<-girafe_options(p,
                                  opts_hover(css=hover_css),
                                  opts_tooltip(css=tooltip_css,opacity=.75),
                                  opts_selection(css=selected_css),
                                  opts_zoom(min=1,max=10))
        }
        p
}