R/hooks.R

In fidadoma/scanpatterns: Set of functions used for working with scan patterns

#' Function that is run on loading
#'
#' @param libname 
#' @param pkgname 
#'
#' @return
#' @export
#'
#' @examples
.onLoad <- function(libname, pkgname) {
  assign("pkg_globals", new.env(), envir=parent.env(environment()))
  assign("eye-dir", "cache/eye", pkg_globals)
  assign("spaces-dir", "cache/space", pkg_globals)
  assign("arenamin", -15, pkg_globals)
  assign("arenamax", 15, pkg_globals)
  assign("xystep", 0.25, pkg_globals)
  assign("tstep", 0.02, pkg_globals)
  assign("tmax", 6, pkg_globals)
  assign("max-time", 5997, pkg_globals)
  assign("min-time", 1, pkg_globals)
  assign("step-time", 4, pkg_globals)
  assign("xsd", 1.2, pkg_globals)
  assign("ysd", 1.2, pkg_globals)
  assign("tsd", 0.0265, pkg_globals)
  
}
#' Function that is run on attaching
#' @description 
#' Set default parameters for the package
#' @param libname 
#' @param pkgname 
#'
#' @return
#' @export
#'
#' @examples
.onAttach <- function(libname, pkgname) {
  
  assign("eye-dir", "cache/eye", pkg_globals)
  assign("spaces-dir", "cache/space", pkg_globals)
  assign("arenamin", -15, pkg_globals)
  assign("arenamax", 15, pkg_globals)
  assign("xystep", 0.25, pkg_globals)
  assign("tstep", 0.02, pkg_globals)
  assign("tmax", 6, pkg_globals)
  assign("max-time", 5997, pkg_globals)
  assign("min-time", 1, pkg_globals)
  assign("step-time", 4, pkg_globals)
  assign("xsd", 1.2, pkg_globals)
  assign("ysd", 1.2, pkg_globals)
  assign("tsd", 0.0265, pkg_globals)
  
}

#' Function for setting global parameters
#'
#' @param l List with individual parameters that will be changed
#'
#' @return
#' @export
#'
#' @examples
#' scanpatterns.set.parameters(list("max-time" = 40))
scanpatterns.set.parameters<-function(l) {
  for(i in 1:length(l)) {
    assign(names(l)[i], l[[i]], pkg_globals)
  }
}