R/plotPlatemap.R

In chapmandu2/IncucyteDRC: Dose Response Curves from Incucyte Proliferation Assays

#' plotPlatemap
#'
#' Visualisation of an Incucyte platemap
#'
#' @param pm Platemap data frame geneated by either importPlatemap or importPlatemapXML functions.
#'
#' @return ggplot object
#' @export
#' @import ggplot2
#'
#' @examples
#' pm_file <- system.file(file='extdata/example.PlateMap', package='IncucyteDRC')
#' test_pm <- importPlatemapXML(pm_file)
#' plotPlatemap(test_pm)
#'
#' library(magrittr)
#' pm_file2 <- system.file(file='extdata/example2.PlateMap', package='IncucyteDRC')
#' importPlatemapXML(pm_file2) %>% plotPlatemap()

plotPlatemap <- function(pm) {

    if(is.null(attr(pm, 'IncucyteDRCPlatemap'))) {
        warning('Recommended that platemap data frames are parsed through importPlatemap function to check formatting')
    }

    p <- ggplot(pm, aes(y=row, x=col)) +
        geom_tile(aes(fill=samptype), colour='black') +
        geom_text(aes(label=sprintf("%s\n%s%s", sampleid, round(conc,4), concunits)), size=rel(2.5)) +
        scale_y_reverse() +
        xlab('') + ylab('') +
        cowplot::theme_cowplot()

    print(p)

}