R/CellSimulation.R

In CancerInSilico: An R interface for computational modeling of tumor progression

#' Simulates Cell Model
#' @export
#'
#' @details This function provides a centralized R interface to run c++
#' code for cell-based models implemented in this package. Standard
#' parameters, as well as model-specific parameters, are passed in to this
#' function along with a model name. This function then runs the model and
#' returns a CellModel object containing all of the information from the
#' model. This object can then be accessed with various functions designed
#' to interact with the class. To see a list of available functions, there
#' is a show() command implemented for CellModel objects.
#' @param initialNum how many cells initially
#' @param runTime how long the simulation runs in real cellular time (hours)
#' @param density initial density of cell population
#' @param modelType the name of the cell-based model to use
#' @param ... model specific parameters (depends on modelType)
#' @return A CellModel containing all info from the model run
#' @examples
#' inSilicoCellModel(initialNum=1, runTime=8, density=0.1)
#' @importFrom methods new
inSilicoCellModel <- function(initialNum, runTime, density, 
modelType = 'DrasdoHohme', ...)
{
    # create cell model object
    model <- new('DrasdoHohmeModel', initialNum = initialNum, 
        runTime = runTime, density = density, ...)
    
    # run model and return result
    return(run(model))
}