Merge pull request #42 from USEPA/names_fix

Fixes for issues #40 and #41

R/lc_get_params.R

@@ -22,6 +22,7 @@ lc_get_params <- function(param = NULL) {
   if (param=='areaOfInterest') params <- resp$parameters$areaOfInterest$options else{
     params <- resp$parameters$name$options
   }
+  params <- params[order(params)]
   return(params)
 }
 
@@ -44,7 +45,7 @@ lc_get_params <- function(param = NULL) {
 #' fullname <- lc_fullname(metric='name')
 
 lc_fullname <- function(metric = NULL) {
-  resp <- as.data.frame(jsonlite::fromJSON("https://java.epa.gov/StreamCAT/LakeCat/metrics/datadictionary"))
-  result <- resp[resp$dictionary.metric_prefix==metric,1]
+  resp <- as.data.frame(jsonlite::fromJSON("https://java.epa.gov/StreamCAT/metrics/datadictionary"))
+  result <- resp[resp$dictionary.metric_prefix %in% unlist(strsplit(metric, split = ',')), 1]
   return(result)
 }

R/sc_get_params.R

@@ -22,6 +22,7 @@ sc_get_params <- function(param = NULL) {
   if (param=='areaOfInterest') params <- resp$parameters$areaOfInterest$options else{
     params <- resp$parameters$name$options
   }
+  params <- params[order(params)]
   return(params)
 }
 
@@ -45,6 +46,6 @@ sc_get_params <- function(param = NULL) {
 
 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]
+  result <- resp[resp$dictionary.metric_prefix %in% unlist(strsplit(metric, split = ',')), 1]
   return(result)
 }

tests/testthat/test-lc_get_params.R

@@ -4,9 +4,9 @@ context("Test that lc_get_params is pulling in StreamCat API parameters")
 test_that("lc_get_params for region parameters", {
   params <- lc_get_params(param='areaOfInterest')
   expect_true(exists("params"))
-  expect_equal(params,c("catchment","watershed",
+  expect_equal(params,c("catchment","other",
                         "riparian_catchment",
-                        "riparian_watershed","other"))
+                        "riparian_watershed","watershed"))
 })
 
 test_that("lc_get_params for name parameters", {

tests/testthat/test-sc_get_params.R

@@ -4,9 +4,9 @@ context("Test that sc_get_params is pulling in StreamCat API parameters")
 test_that("sc_get_params for region parameters", {
             params <- sc_get_params(param='areaOfInterest')
             expect_true(exists("params"))
-            expect_equal(params,c("catchment","watershed",
-                                   "riparian_catchment",
-                                   "riparian_watershed","other"))
+            expect_equal(params,c("catchment","other",
+                                  "riparian_catchment",
+                                  "riparian_watershed","watershed"))
           })
 
 test_that("sc_get_params for name parameters", {

vignettes/Introduction.Rmd

@@ -59,11 +59,17 @@ print(paste0('region parameters are: ', paste(region_params,collapse = ', ')))
 print(paste0('A selection of available StreamCat metrics include: ',paste(name_params[1:10],collapse = ', ')))
 ```
 
-Look up the display name for a metric using the `sc_fullname` function via the API
-```{r Example_One_fullnames}
+Look up the display name or names for a metric using the `sc_fullname` function via the API
+```{r fullnames}
 metric='pcthbwet2011'
 fullname <- sc_fullname(metric)
-print(paste0('The full name for ',metric, ' is: ', paste(fullname,collapse = ', ')))
+fullname
+```
+
+```{r fullnames2}
+metric='pctdecid2019,fert'
+fullname <- sc_fullname(metric)
+fullname
 ```
 
 ## Get data for COMIDs

vignettes/LakeCat.Rmd

@@ -48,6 +48,19 @@ print(paste0('region parameters are: ', paste(region_params,collapse = ', ')))
 print(paste0('A selection of available LakrCat metrics include: ',paste(name_params[1:10],collapse = ', ')))
 ```
 
+Look up the display name or names for a metric using the `lc_fullname` function via the API
+```{r fullnames}
+metric='pcthbwet2011'
+fullname <- lc_fullname(metric)
+fullname
+```
+
+```{r fullnames2}
+metric='pctdecid2019,fert'
+fullname <- lc_fullname(metric)
+fullname
+```
+
 ## Get data for COMIDs
 
 In this example we access several variables, for several areas of interest, and for several COMIDs using the `lc_get_data` function. Loads data into a tibble we can view.