R/occ_names_options.R

In spocc: Interface to Species Occurrence Data Sources

#' Look up options for parameters passed to each source for occ_names function
#'
#' @export
#' 
#' @family queries
#'
#' @param from (character) Data source to get data from, only gbif.
#' Case doesn't matter.
#' @param where (character) One of console (print to console) or html 
#' (opens help page, if in non-interactive R session, prints help to console).
#'
#' @return Opens up the documentation for the function that is used internally 
#' within the occ function for each source.
#' @details Any of the parameters passed to e.g. [rgbif::name_lookup()] from the
#' \code{rgbif} package can be passed in the associated gbifopts list 
#' in [occ()].
#'
#' Note that the from parameter is lowercased within the function and is 
#' called through `match.arg` first, so you can match on unique partial 
#' strings too (e.g., 'rg' for 'rgbif').
#' @examples \dontrun{
#' # opens up documentation for this function
#' occ_names_options()
#'
#' # Open up documentation for the appropriate search function for each source
#' occ_names_options('gbif')
#'
#' # Or open in html version
#' occ_names_options('gbif', 'html')
#' }

occ_names_options <- function(from = 'gbif', where="console"){
  from <- tolower(from)
  from <- match.arg(from, choices = c('gbif'))
  pkgname <- switch(from, gbif = 'rgbif')
  check_for_package(pkgname)
  fxn <- switch(from, gbif = 'name_lookup')
  if (where == "console") {
    res <- tools::Rd_db(pkgname)
    fxnrd <- res[[sprintf('%s.Rd', fxn)]]
    params <- fxnrd[ which(rd_tags(fxnrd) == "\\arguments") ]
    pars <- unlist(sc(sapply(params[[1]], function(x){
      if (!x[[1]] == "\n") {
        paste(x[[1]], gsub("\n", "", paste(unlist(x[[2]]), collapse = " ") ), 
              sep = " - ")
      }
    })))
    cat(sprintf("%s parameters:", fxn), sapply(pars, spocc_wrap, 
                                               indent = 6, width = 80, 
                                               USE.NAMES = FALSE), sep = "\n")
  } else {
    showit <- switch(from,
                     gbif = "?rgbif::name_lookup")
    eval(parse(text = showit))
  }
}