R/examples_for_oiplot.R

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

#' optint.empty
#'
#' An empty list having structure and names required for using function optint. Users can populate with
#'   their desired values. See vignette for appropriate and recommended use.
#'   See also optint.ex1 and optint.ex2.
#'
#'
#' @format A list having 8 components. Each component itself consists of two components.
#'   "parameter" names the parameter. "value" specifies the numeric value.
#' \describe{
#'   \item{COL}{parameter varied along x-axis}
#'   \item{ROW}{parameter varied between plots}
#'   \item{SER}{parameter varied among lines within a plot}
#'   \item{DIM1}{parameter varied alongone dimension of area from which "favorability of integration"
#'     is calculated}
#'   \item{DIM2}{parameter varied alongone 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}
#'   ...
#' }
#' @source NA


# a list structured for users to input parameter values for users to make plots using function "optint"
optint.empty <- lapply(rep(NA, 8), function(x){list(param = NA, value = NA)})

names(optint.empty) <- c("COL", "ROW", "SER", "DIM1", "DIM2", "CONST1", "CONST2", "CONST3")


#' optint.ex1
#'
#' An example list for making plots with oiplot Reproduces Fig. 2 in
#'   Munoz & Blumstein (under review at Behavioral Ecology).
#'
#'
#' @format A list having 8 components. Each component itself consists of two components.
#'   "parameter" names the parameter. "value" specifies the numeric value. See vignette
#'   for further details.
#'   ...
#'
#' @source NA




optint.ex1 <- list(
  COL = 	 list(param = "u1", value = seq(0.1, 0.9, length.out = 15)),
  ROW = 	 list(param = "u2", value = c(0.2, 0.8)),
  SER = 	 list(param = "prior.b", value = c(0.2, 0.5, 0.8)),
  DIM1 = 	 list(param = "bb.a", value = seq(0.1, 5, length.out = 20)),
  DIM2 = 	 list(param = "bb.b", value = seq(0.1, 5, length.out = 20)),
  CONST1 = list(param = "k1", value = 0),
  CONST2 = list(param = "k2", value = 1),
  CONST3 = list(param = "s1", value = -1)
)


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

optint.ex2 <- list(
  COL = 	 list(param = "k2", value = seq(0, 20, length.out = 15)),
  ROW = 	 list(param = "prior.b", value = c(0.6, 0.2)),
  SER = 	 list(param = "u1", value = c(0.3, 0.7)),
  DIM1 = 	 list(param = "bb.a", value = seq(0.1, 5, length.out = 20)),
  DIM2 = 	 list(param = "bb.b", value = seq(0.1, 5, length.out = 20)),
  CONST1 = list(param = "k1", value = 0),
  CONST2 = list(param = "u2", value = 0.2),
  CONST3 = list(param = "s1", value = 1)
)