R/vars.R

In eva3dm: Evaluation of 3D Meteorological and Air Quality Models

#' Function to return variable names
#'
#' @description Return variable names of a NetCDF
#'
#' @param file file name
#' @param action 'get' to return variable names or 'print' to print
#' @param verbose display additional information
#'
#' @return string
#'
#' @import ncdf4
#'
#' @export
#'
#' @examples
#' vars(paste0(system.file("extdata",package="eva3dm"),'/wrfinput_d01'))
#'

vars <- function(file = NA, action="get", verbose=FALSE){
  meta <- NULL
  on.exit(ncdf4::nc_close(meta))

  if(is.na(file[1])){
    if(verbose) cat("choose a file:\n") # nocov
    file <- file.choose()   # nocov
    if(verbose) cat(paste(file,"\n"))   # nocov
  }

  meta <- ncdf4::nc_open(filename = file, verbose = verbose, write = FALSE)

  if(action == 'print'){
    return(cat(names(meta$var),'\n'))
  }else{
    return(names(meta$var))
  }
}