R/modelfunction_sigmoid.R

In ropensci/DoOR.functions: Integrating Heterogeneous Odorant Response Data into a Common Response Model: A DoOR to the Complete Olfactome

# Logistic Model
#
# Logistic Model
#
# expression : Asym/(1+exp((xmid-input)/scal))
#
# @param input numeric vector of data values
# @param parms numeric vector, parameters with given names: "Asym", "xmid",
# "scal"
# @seealso \code{\link{SSlogis}}
# @references Jose Pinheiro and Douglas Bates
# @keywords math
# @examples
#
# x <- rnorm(20)
# y <- modelfunction_sigmoid(input = x, parms = c(Asym = 0.1, xmid = 0.2, 
#                                                 scal = 0.3) )
# plot(x,y)
#' @importFrom stats SSlogis
modelfunction_sigmoid <- function(input, parms) {
  return(SSlogis(
    input,
    Asym = parms["Asym"],
    xmid = parms["xmid"],
    scal = parms["scal"]
  ))
}