R/sc_get_params.R

In mhweber/StreamCatTools: Streamcat Tools

#' @title Get StreamCat Parameters
#' 
#' @description 
#' Function to return available StreamCat parameters using the StreamCat API.  
#' 
#' @author 
#' Marc Weber
#' 
#' @param param Either name or area to grab JSON of parameters in API
#' Syntax: param=<value1>,<value2>
#' Values: name|area
#'  
#' @return A list of all the current StreamCat values for a given parameter
#' @export
#'
#' @examples
#' params <- sc_get_params(param='name')
#' params <- sc_get_params(param='area')

sc_get_params <- function(param = NULL) {
  resp <- jsonlite::fromJSON("https://java.epa.gov/StreamCAT/metrics")
  if (param=='areaOfInterest') params <- resp$parameters$areaOfInterest$options else{
    params <- resp$parameters$name$options
  }
  return(params)
}

#' @title Lookup Full Metric Name
#' 
#' @description 
#' Function to retrieve a full metric name based on the short name using the StreamCat API.  
#' 
#' @author 
#' Marc Weber
#' 
#' @param metric Short metric name
#' Syntax: metric=value1
#' Values: metric
#'  
#' @return A lookup of the full name for a given StreamCat metric
#' @export
#'
#' @examples
#' fullname <- sc_fullname(metric='name')

sc_fullname <- function(metric = NULL) {
  resp <- as.data.frame(jsonlite::fromJSON("https://java.epa.gov/StreamCAT/metrics/datadictionary"))
  result <- resp[resp$dictionary.metric_prefix==metric,1]
  return(result)
}