R/getGlobalDirectory.r

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

#' @title
#' Get Global Directory
#'
#' @description 
#' Retrieves the option that corresponds to the path of the global directory 
#' associated to the \code{rapp} framework and its associated packages and
#' applications.
#'   	
#' @param ns \strong{Signature argument}.
#'    Object containing namespace information.
#' @template threedot
#' @example inst/examples/getGlobalDirectory.r
#' @seealso \code{
#'   	\link[rapp]{getGlobalDirectory-missing-method}
#' }
#' @template author
#' @template references
#' @export 
#' @import libr
setGeneric(
  name = "getGlobalDirectory",
  signature = c(
    "ns"
  ),
  def = function(
    ns,
    ...
  ) {
    standardGeneric("getGlobalDirectory")       
  }
)

#' @title
#' Get Global Directory
#'
#' @description 
#' See generic: \code{\link[rapp]{getGlobalDirectory}}
#'      
#' @inheritParams getGlobalDirectory
#' @param ns \code{\link{missing}}. Default ns.
#' @return \code{\link{character}}. Option value.
#' @example inst/examples/getGlobalDirectory.r
#' @seealso \code{
#'    \link[rapp]{getGlobalDirectory}
#' }
#' @template author
#' @template references
#' @export
setMethod(
  f = "getGlobalDirectory", 
  signature = signature(
    ns = "missing"
  ), 
  definition = function(
    ns,
    ...
  ) {
  
  return(getRappOption(id = ".rte/global_dir", ...))
    
  }
)