R/exportEC50Data.R

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

#' exportEC50Data
#'
#' Exports EC50 data into a standard data frame format from the dose response fit for an IncucyteDRCSet object
#'
#' @param idrc_set IncucyteDRCSet object
#' @param add_metadata Whether or not to merge IncucyteDRCSet metadata into the output
#'
#' @return IncucyteDRCSet object
#' @export
#'
#' @examples
#' pm_file <- system.file(file='extdata/example.PlateMap', package='IncucyteDRC')
#' test_pm <- importPlatemapXML(pm_file)
#' data_file <- system.file(file='extdata/example_data.txt', package='IncucyteDRC')
#' test_data <- importIncucyteData(data_file, metric='pc')
#'
#' test_list <- splitIncucyteDRCPlateData(test_pm, test_data, group_columns='growthcondition')
#'
#' print(test_list)
#'
#' test_idrc_set <- fitGrowthCurvesGrouped(test_list[[2]])
#' test_idrc_set <- fitGrowthCurvesIndividual(test_idrc_set)
#' test_idrc_set <- calculateDRCData(test_idrc_set, cut_time=100)
#' test_idrc_set <- fitDoseResponseCurve(test_idrc_set)
#' test_idrc_set <- calculateEC50(test_idrc_set)
#' exportEC50Data(test_idrc_set)
#'
exportEC50Data <- function(idrc_set, add_metadata=FALSE) {

    #make sure that fitDoseResponseCurve has been run
    if(is.null(idrc_set$drc_ec50)) {
        stop("Need to run calculateEC50 function first to calculate EC50 values for the object")
    }

    out_df <- idrc_set$drc_ec50

    if(add_metadata & is.data.frame(idrc_set$metadata)) {
        out_df <- merge(out_df, idrc_set$metadata)
    }

    return(as.data.frame(out_df))

}