R/examples_for_aplot.R

In nicolemunoz99/multisensory: Predicting the conditions under which multisensory integration is favored

#' favint.empty
#'
#' An empty list having structure and names required for using function favint.empty Users can populate with
#'   their desired values. See vignette for appropriate and recommended use.
#'   See also favint.ex1.
#'
#'
#' @format A list having 8 components. Each component itself consists of two components.
#'   "parameter" text naming the parameter. "value" specifies the numeric value(s) as a vector.
#' \describe{
#'   \item{COL}{parameter varied between plots}
#'   \item{DIM1}{parameter varied along one dimension of area from which "favorability
#'     of integration"is calculated}
#'   \item{DIM2}{parameter varied along the other dimension of area from which "favorability
#'     of integration" is calculated}
#'   \item{CONST1}{parameter held constant}
#'   \item{CONST2}{parameter held constant}
#'   \item{CONST3}{parameter held constant}
#'   \item{CONST4}{parameter held constant}
#'   \item{CONST5}{parameter held constant}
#'   ...
#' }
#' @source NA


# a list structured for users to input parameter values for users to make plots using function "optint"
favint.empty <- lapply(rep(NA, 8), function(x){list(param = NA, value = NA)})
names(favint.empty) <- c("COL", "DIM1", "DIM2", "CONST1", "CONST2", "CONST3", "CONST4", "CONST5")






#' favint.ex1
#'
#' An example list for making plots with aplot.
#'
#'
#' @format A list having 8 components. Each component itself consists of two components.
#'   "parameter" names the parameter. "value" specifies the numeric value.
#'   ...
#'
#' @source NA

favint.ex1 <- list(
  COL = 	 list(param = "u1", value = c(0.2, 0.6)),
  DIM1 = 	 list(param = "bb.a", value = seq(0.1, 5, length.out = 30)),
  DIM2 = 	 list(param = "bb.b", value = seq(0.1, 5, length.out = 30)),
  CONST1 = list(param = "k1", value = 0),
  CONST2 = list(param = "k2", value = 1),
  CONST3 = list(param = "s1", value = 2),
  CONST4 = 	 list(param = "u2", value = 0.8),
  CONST5 = 	 list(param = "prior.b", value = 0.2)
)


#' favint.ex2
#'
#' An example list for making plots with aplot.
#'
#'
#' @format A list having 8 components. Each component itself consists of two components.
#'   "parameter" names the parameter. "value" specifies the numeric value.
#'   ...
#'
#' @source NA

favint.ex2 <- list(
  COL = 	 list(param = "prior.b", value = c(0.1, 0.6)),
  DIM1 = 	 list(param = "bb.a", value = seq(0.1, 5, length.out = 50)),
  DIM2 = 	 list(param = "bb.b", value = seq(0.1, 5, length.out = 50)),
  CONST1 = list(param = "k1", value = 0),
  CONST2 = list(param = "k2", value = 1),
  CONST3 = list(param = "s1", value = 2),
  CONST4 = 	 list(param = "u2", value = 0.8),
  CONST5 = 	 list(param = "u1", value = 0.4)
)