R/z_map.R

In Swarchal/platetools: Tools and Plots for Multi-Well Plates

#' Plots a platemap with heatmap of scaled values
#'
#' Converts numerical values and  well labels into multiple plate heatmaps
#'
#' @param data Numerical values to be plotted
#' @param well Vector of well identifiers e.g "A01"
#' @param plate Number of wells in complete plate (6, 12, 24, 48, 96, 384 or 1536))
#' @param ... additional parameters to plot wrappers
#'
#' @return ggplot plot
#'
#' @import ggplot2
#' @export
#'
#' @examples
#' df <- data.frame(vals = rnorm(1:384),
#'   well = num_to_well(1:384, plate = 384))
#'
#' z_map(data = df$vals,
#'       well = df$well,
#'       plate = 384)


z_map <- function(data, well, plate = 96, ...){

    stopifnot(is.vector(data))

    check_plate_input(well, plate)

    platemap <- plate_map_scale(data, well)

    if (plate == 6L){
        plt <- plt6(platemap, ...) + theme_bw()
    } else if (plate == 12L){
        plt <- plt12(platemap, ...) + theme_bw()
    } else if (plate == 24L){
        plt <- plt24(platemap, ...) + theme_bw()
    } else if (plate == 48L){
        plt <- plt48(platemap, ...) + theme_bw()
    } else if (plate == 96L){
        plt <- plt96(platemap, ...) + theme_bw()
    } else if (plate == 96L){
        plt <- plt96(platemap, ...) + theme_bw()
    } else if (plate == 384L){
        plt <- plt384(platemap, ...) + theme_bw()
    } else if (plate == 1536L) {
        plt <- plt1536(platemap, ...) + theme_bw()
    } else {
        stop("Not a valid plate format. Enter either 6, 12, 24, 48, 96, 384 or 1536.",
            call. = FALSE)
    }

    return(plt)
}