R/getNsRappOption.r

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

#' @title
#' Get Namespace Rapp Options
#'
#' @description 
#' Retrieves namespace-specific \code{rapp} options. These are usually 
#' options associated to package projects or applications. 
#' See \code{\link[rapp]{mergeNsRappOptions}}.
#' 
#' @details
#' Providing a value for \code{ns} but none for \code{id} retrieves the 
#' entire options container for the respective context (if it exists; e.g.
#' \code{ns = "my.package"}).
#' Providing a value for \code{id} will result in the method looking for 
#' an option based on the following ID path: \code{ns/id}, 
#' e.g. \code{"my.package/option_1"}.
#'   	
#' @param ns \strong{Signature argument}.
#'    Object containing namespace information.
#' @param id \strong{Signature argument}.
#'    Object containing path-like ID information.
#' @template threedot
#' @example inst/examples/getNsRappOption.r
#' @seealso \code{
#'   	\link[rapp]{getNsRappOption-character-character-method}
#' }
#' @template author
#' @template references
#' @export 
#' @import libr
setGeneric(
  name = "getNsRappOption",
  signature = c(
    "ns",
    "id"
  ),
  def = function(
    ns = ifelse(isPackageProject("."), devtools::as.package(x = ".")$package,
                 character()),
    id = character(),
    ...
  ) {
    standardGeneric("getNsRappOption")       
  }
)

#' @title
#' Get Context-Specific Rapp Options
#'
#' @description 
#' See generic: \code{\link[rapp]{getNsRappOption}}
#'      
#' @inheritParams getNsRappOption
#' @param ns \code{\link{missing}}. Default namespace.
#' @param id \code{\link{missing}}. Default ID.
#' @return See method 
#'   \code{\link[rapp]{getNsRappOption-character-character-method}}
#' @example inst/examples/getNsRappOption.r
#' @seealso \code{
#'    \link[rapp]{getNsRappOption}
#' }
#' @template author
#' @template references
#' @export
setMethod(
  f = "getNsRappOption", 
  signature = signature(
    ns = "missing",
    id = "missing"
  ), 
  definition = function(
    ns,
    id,
    ...
  ) {
  
  return(getNsRappOption(ns = ns, id = id, ...))
    
  }
)

#' @title
#' Get Context-Specific Rapp Options
#'
#' @description 
#' See generic: \code{\link[rapp]{getNsRappOption}}
#'      
#' @inheritParams getNsRappOption
#' @param ns \code{\link{character}}.
#' @param id \code{\link{missing}}. 
#' @return See method 
#'   \code{\link[rapp]{getNsRappOption-character-character-method}}
#' @example inst/examples/getNsRappOption.r
#' @seealso \code{
#'    \link[rapp]{getNsRappOption}
#' }
#' @template author
#' @template references
#' @export
setMethod(
  f = "getNsRappOption", 
  signature = signature(
    ns = "character",
    id = "missing"
  ), 
  definition = function(
    ns,
    id,
    ...
  ) {
  
  return(getNsRappOption(ns = ns, id = id, ...))
    
  }
)

#' @title
#' Get Context-Specific Rapp Options
#'
#' @description 
#' See generic: \code{\link[rapp]{getNsRappOption}}
#'      
#' @inheritParams getNsRappOption
#' @param ns \code{\link{missing}}.
#' @param id \code{\link{character}}. 
#' @return See method 
#'   \code{\link[rapp]{getNsRappOption-character-character-method}}
#' @example inst/examples/getNsRappOption.r
#' @seealso \code{
#'    \link[rapp]{getNsRappOption}
#' }
#' @template author
#' @template references
#' @export
setMethod(
  f = "getNsRappOption", 
  signature = signature(
    ns = "missing",
    id = "character"
  ), 
  definition = function(
    ns,
    id,
    ...
  ) {
  
  return(getNsRappOption(ns = ns, id = id, ...))
    
  }
)

#' @title
#' Get Context-Specific Rapp Options
#'
#' @description 
#' See generic: \code{\link[rapp]{getNsRappOption}}
#'      
#' @inheritParams getNsRappOption
#' @param ns \code{\link{character}}.
#' @param id \code{\link{character}}.
#' @return \code{\link{logical}}. Return value of 
#'    \code{\link[rapp]{setRappOption}}.
#' @example inst/examples/getNsRappOption.r
#' @seealso \code{
#'    \link[rapp]{getNsRappOption}
#' }
#' @template author
#' @template references
#' @export
setMethod(
  f = "getNsRappOption", 
  signature = signature(
    ns = "character",
    id = "character"
  ), 
  definition = function(
    ns,
    id,
    ...
  ) {
  
  if (length(id)) {
    id <- file.path(ns, id)
  } else {
    id <- ns
  }
  return(getRappOption(id = id))
   
  }
)