R/initializeRappOptions.r

In rappster/rapp: Runtime environment for package development and application deployment in the context of the rapp framework

#' @title
#' Initialize Rapp Options
#'
#' @description 
#' Ensures initial options as expected by the \code{rapp} framework and its 
#' associated packages. The options are stored as \code{".rapp"} in 
#' \code{\link[base]{options}}.
#'   	
#' @param ns \strong{Signature argument}.
#'    Object containing namespace information.
#' @template threedot
#' @example inst/examples/initializeRappOptions.r
#' @seealso \code{
#'   	\link[rapp]{initializeRappOptions-missing-method}
#' }
#' @template author
#' @template references
#' @export 
setGeneric(
  name = "initializeRappOptions",
  signature = c(
    "ns"
  ),
  def = function(
    ns,
    ...
  ) {
    standardGeneric("initializeRappOptions")       
  }
)

#' @title
#' Initialize Rapp Options
#'
#' @description 
#' See generic: \code{\link[rapp]{initializeRappOptions}}
#'   	 
#' @inheritParams initializeRappOptions
#' @param ns \code{\link{missing}}. Default namespace.
#' @return \code{\link{environment}}. The options container as stored in 
#'    \code{options(".rapp")}.
#' @example inst/examples/initializeRappOptions.r
#' @seealso \code{
#'    \link[rapp]{initializeRappOptions}
#' }
#' @template author
#' @template references
#' @export
setMethod(
  f = "initializeRappOptions", 
  signature = signature(
    ns = "missing"
  ), 
  definition = function(
    ns,
    ...
  ) {
    
  container <- ensureRappOptionsContainer(overwrite = TRUE)
  
  setRappOption(
    id = ".rte/global_dir",
    value = file.path(Sys.getenv("HOME"), "rapp"),
    branch_gap = TRUE
  )
  setRappOption(
    id = ".rte/repos_root",
    value = NA_character_
  )
  setRappOption(
    id = ".rte/repos_global",
    value = NA_character_
  )
  setRappOption(
    id = ".rte/repos_pkgs",
    value = NA_character_
  )
  setRappOption(
    id = ".rte/runtime_mode",
    value = "dev",
    branch_gap = TRUE
  )
  
  ## Prime stuff //
  if (!isRapp()) {
    setRappOption(
      id = ".rte/ns_prime",
      value = devtools::as.package(".")$package,
      branch_gap = TRUE
    )
#     setRappOption(
#       id = ".rte/ns_prime_type",
#       value = switch(!isRapp(), "TRUE" = "package", "FALSE" = "rapp"),
#       branch_gap = TRUE
#     )
    setRappOption(
      id = ".rte/wd_prime",
      value = getwd(),
      branch_gap = TRUE
    )
  }
  
  return(container)
    
  }
)