R/search.R

In poissonconsulting/fwabc: Read Data from the BC Freshwater Atlas

#' Search valid GNIS_NAME.
#'
#' @param pattern A character string containing a regular expression (or character string for fixed = TRUE) to be matched.
#' @param layer A valid layer from fwa_lookup_layer.
#' @param ignore_case A flag of whether to ignore case when matching regular expression.
#' @param ... Arguments passed to grepl.
#' @return A character vector.
#' @examples
#' fwa_search_gnis("sangan")
#' @export
fwa_search_gnis <- function(pattern, layer = NULL, ignore_case = TRUE, ...){

  check_layer(layer)
  check_character(pattern)
  check_flag(ignore_case)

  gnis <- lookup_gnis$GNIS_NAME
  if(!is.null(layer)){
    gnis <- lookup_gnis$GNIS_NAME[lookup_gnis[[layer]]]
  }
  unique(gnis[grepl(pattern, gnis, ignore.case = ignore_case, ...)])
}

#' Search valid WATERSHED_GROUP_NAME.
#'
#' @inheritParams fwa_search_gnis
#' @return A character vector.
#' @examples
#' fwa_search_watershed_group("graham")
#' @export
fwa_search_watershed_group <- function(pattern, layer = NULL,
                                       ignore_case = TRUE, ...){
  check_layer(layer)

  wsgroup <- lookup_wsgroup$WATERSHED_GROUP_NAME
  if(!is.null(layer)){
    wsgroup <- lookup_wsgroup$WATERSHED_GROUP_NAME[lookup_wsgroup[[layer]]]
  }
  unique(wsgroup[grepl(pattern, wsgroup, ignore.case = ignore_case, ...)])
}