R/getParkNames.R

In NCRN/NCRNbirds: Data analysis and visualization for NPS I&M bird monitoring.

#' @include NCRNbirds_Class_def.R 
#' @title getParkNames
#' 
#' @description Retreives park names from an NCRNbirds object or a list of such objects.
#' 
#' @param object Either an NPSbirds object or a list of such objects.
#' @param name.class Type of name to return. One of three options, in quotes.
#' \describe{
#' \item{"short"}{ The default. Returns the short name of the park}
#' \item{"long"}{Returns the long name of the park}
#' \item{"code"}{Returns the park code}
#' } 
#' @return A character vector with one or more park names. 
#' 
#' @export

setGeneric(name="getParkNames",function(object,name.class="short"){standardGeneric("getParkNames")},signature=c("object") )


setMethod(f="getParkNames", signature=c(object="list"),
          function(object,name.class){
            sapply(object,FUN=getParkNames, name.class=name.class) } )  


setMethod(f="getParkNames", signature=c(object="NCRNbirds"),
          function(object,name.class){
            switch(name.class,
                   code = return(object@ParkCode),
                   short = return(object@ShortName),
                   long = return(object@LongName),
                   stop("Unrecognized type in getNames")
            )
          })