R/MakeDecisionDoses.R

In kwathen/OCTOPUS: OCTOPUS

##### COPYRIGHT #############################################################################################################
#
# Copyright (C) 2018 JANSSEN RESEARCH & DEVELOPMENT, LLC
# This package is governed by the JRD OCTOPUS License, which is the
# GNU General Public License V3 with additional terms. The precise license terms are located in the files
# LICENSE and GPL.
#
#############################################################################################################################.

#' @name MakeDecisionDoses
#' @title MakeDecisionDoses
#' @description {This function provides options for making decisons when doses are included in an ISA. }
#' @seealso { \href{https://github.com/kwathen/OCTOPUS/blob/master/R/MakeDecisionDoses.R}{View Code on GitHub} }
#' @export
MakeDecisionDoses<- function( lDoseDec )
{
    UseMethod( "MakeDecisionDoses", lDoseDec )
}


#' @name MakeDecisionDoses.default
#' @title MakeDecisionDoses.default
#' @description {Generic function to make decisions when doses are present in an ISA.
#' No default defined so the simulations stop if a specific approach is not defined.  }
#' @seealso { \href{https://github.com/kwathen/OCTOPUS/blob/master/R/MakeDecisionDoses.R}{View Code on GitHub} }
#' @export
MakeDecisionDoses.default <- function( lDoseDec )
{

    stop("ERROR: The default MakeDecisionDoses.default is not defined, class(lDecision) = ", class(lDoseDec))

}

#' @name MakeDecisionDoses.HighDoseOnly
#' @title MakeDecisionDoses.HighDoseOnly
#' @description {"This option allows for multiple doses but only uses the high dose for decision making "  }
#' @seealso { \href{https://github.com/kwathen/OCTOPUS/blob/master/R/MakeDecisionDoses.R}{View Code on GitHub} }
#' @export
MakeDecisionDoses.HighDoseOnly <- function( lDoseDec )
{

    nQtyDose <- length( lDoseDec )
    lRet     <- lDoseDec[[nQtyDose]]

    return( lRet )
}


#' @name MakeDecisionDoses.AtLeastOne
#' @title MakeDecisionDoses.AtLeastOne
#' @description {This option allows for mulitiple doses and if all doses reach a No Go decision
#' then the combined decision is a No Go.  If ANY dose is a Go then a Go decision is made.     }
#' @seealso { \href{https://github.com/kwathen/OCTOPUS/blob/master/R/MakeDecisionDoses.R}{View Code on GitHub} }
#' @export
MakeDecisionDoses.AtLeastOne <- function( lDoseDec )
{

    #print( "MakeDecisionDoses.AtLeastOne" )
    lRet     <- list( nGo= 0, nNoGo = 0, nPause = 1)
    nQtyDose <- length( lDoseDec )
    nQtyNoGo <- 0
    nQtyGo   <- 0
    for( i in 1:nQtyDose )
    {
        if( is.na(  lDoseDec[[i]]$nGo ) |  is.na( lDoseDec[[i]]$nNoGo)  )
        {
            strErr <- paste( "Error in MakeDecisionDoses.AtLeastOne ( MakeDecisionsDoses.R ): For dose, ", i, " an NA was suppled for $nGo or $nNoGo. ")
            strErr <- paste( strErr, "  All doses you must define $nGo and $nNoGo as 0 or 1")
            stop( strErr )
        }
        else
        {
            nQtyGo   <- nQtyGo   + lDoseDec[[i]]$nGo
            nQtyNoGo <- nQtyNoGo + lDoseDec[[i]]$nNoGo
        }

    }
    if( nQtyNoGo == nQtyDose )
        lRet <- list( nGo= 0, nNoGo = 1, nPause = 0)
    else if( nQtyGo >= 1 )
        lRet <- list( nGo= 1, nNoGo = 0, nPause = 0)
    return( lRet )
}



#' @name MakeDecisionDoses.MakeDecisionMCPMod
#' @title MakeDecisionDoses.MakeDecisionMCPMod
#' @seealso { \href{https://github.com/kwathen/OCTOPUS/blob/master/R/MakeDecisionDoses.R}{View Code on GitHub} }
#' @export
MakeDecisionDoses.MakeDecisionMCPMod <- function( lDoseDec )
{
    lRet     <- list( nGo= 0, nNoGo = 0, nPause = 1)
    nQtyDose <- length( lDoseDec )
    nQtyNoGo <- 0
    nQtyGo   <- 0
    for( i in 1:nQtyDose )
    {
        nQtyGo   <- nQtyGo   + lDoseDec[[i]]$nGo
        nQtyNoGo <- nQtyNoGo + lDoseDec[[i]]$nNoGo


    }
    if( nQtyNoGo == nQtyDose )
        lRet <- list( nGo= 0, nNoGo = 1, nPause = 0)
    else if( nQtyGo >= 2 )
        lRet <- list( nGo= 1, nNoGo = 0, nPause = 0)
    return( lRet )
}