R/ra_variable_name.R

In skgrange/gissr: Tools To Make Working With R and Spatial Data Easier

#' Function to extract the variable name from a raster object. 
#' 
#' @param ra Raster object. 
#' 
#' @author Stuart K. Grange.
#' 
#' @return Character vector with length of 1.  
#' 
#' @export
ra_variable_name <- function(ra) {
  
  # Check input
  stopifnot(is.ra(ra))
  
  # Capture printed output and clean
  x <- capture.output(ra)
  
  # Get the varname
  x_filter <- stringr::str_subset(x, "varname")
  
  # If the varname does not exist, get names
  if (length(x_filter) == 0) {
    x_filter <- stringr::str_subset(x, "names")
  }
  
  # Format the output
  x_filter <- format_ra_variable_output(x_filter)
  
  # If empty make NA
  if (length(x_filter) == 0) x_filter <- NA_character_
  
  return(x_filter)
  
}


format_ra_variable_output <- function(x) {
  
  x %>% 
    stringr::str_split_fixed(":", n = 2) %>% 
    .[, 2] %>% 
    stringr::str_trim()
  
}


#' @rdname ra_variable_name
#' @export
ra_level <- function(ra) {
  
  # Check input
  stopifnot(is.ra(ra))
  
  ra %>% 
    capture.output %>% 
    stringr::str_subset("level") %>% 
    stringr::str_split_fixed(":", 2) %>% 
    .[, 2] %>% 
    stringr::str_trim() %>% 
    as.integer()
  
}


#' @rdname ra_variable_name
#' @export
ra_z_var <- function(ra) {
  
  # Check input
  stopifnot(is.ra(ra))
  
  ra %>% 
    capture.output() %>% 
    stringr::str_subset("zvar") %>% 
    stringr::str_split_fixed(":", n = 2) %>% 
    .[, 2] %>% 
    stringr::str_squish()
  
}