Fixes for Rcmd checks

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: StreamCatTools
 Type: Package
-Title: Tools to work with the StreamCat API within R and access the full suite of StreamCat and LakeCat metrics.
+Title: Tools to work with the StreamCat API within R and access the full suite of StreamCat and LakeCat metrics
 Version: 0.3.0
 Authors@R: c(person(given = "Marc", 
                     family = "Weber", 
@@ -35,7 +35,8 @@ Suggests:
   xml2,
   magrittr,
   readr,
-  tidyr
+  tidyr,
+  stringr
 Encoding: UTF-8
 URL: https://usepa.github.io/StreamCatTools/, https://github.com/USEPA/StreamCatTools
 VignetteBuilder: knitr,rmarkdown

R/lc_get_data.R

@@ -77,7 +77,11 @@ lc_get_data <- function(metric = NULL,
     httr2::resp_body_string() |> 
     jsonlite::fromJSON()
   # End of function. Return a data frame.
-  return(df$items)
+  if (is.null(countOnly)){
+    df <- df$items  |> 
+      dplyr::select(comid, dplyr::everything())
+    return(df)
+  } else return(df$items)
 }
 
 #' @title Get NLCD Data

R/sc_get_data.R

@@ -69,9 +69,9 @@
 #' showAreaSqKm=TRUE, showPctFull=TRUE)
 #'
 #' df <- sc_get_data(metric='pcturbmd2006,damdens',
-#' aoi='cat,ws', comid='179,1337,1337420', countOnly=TRUE)
+#' aoi='cat,ws', comid='179,1337,1337420', countOnly='true')
 #'
-#' df <- sc_get_data(metric='ThalwagDepth', comid='179,1337,1337420')
+#' df <- sc_get_data(metric='ThalwagDepth', comid='179,1337,1337420',aoi='other')
 #'  }
 #' @export
 
@@ -104,7 +104,6 @@ sc_get_data <- function(comid = NULL,
       if (stringr::str_detect(aoi,'riparian_watershed')) {
         aoi <- gsub('riparian_watershed','wsrp100',aoi)
       }
-      if (aoi == 'other') aoi <- NULL
     }
     if ((is.null(comid) & is.null(state) & is.null(county) & is.null(region) & is.null(conus)) | is.null(metric) |is.null(aoi)){
       stop('Must provide at a minimum valid comid, metric and aoi to the function')
@@ -125,8 +124,12 @@ sc_get_data <- function(comid = NULL,
     # extract response body as string
     httr2::resp_body_string() |> 
     jsonlite::fromJSON()
-    # End of function. Return a data frame.
-    return(df$items)
+  # End of function. Return a data frame.
+  if (is.null(countOnly)){
+    df <- df$items  |> 
+      dplyr::select(comid, dplyr::everything())
+    return(df)
+  } else return(df$items)
 }
 
 #' @title Get NLCD Data

R/sc_get_params.R

@@ -22,7 +22,7 @@ sc_get_params <- function(param = NULL) {
   resp <- jsonlite::fromJSON("https://api.epa.gov/StreamCat/streams/metrics")$items
   if (param=='areaOfInterest'){
     params <- strsplit(stringr::str_sub(resp$aoi_param_info[[1]]$options,2,-2),",")[[1]]
-    params <- gsub(" ","", params)
+    params <- c(gsub(" ","", params),'other')
   }  else {
     params <- resp$name_options[[1]][[1]]
   }

tests/testthat/test-sc_get_params.R

@@ -4,7 +4,7 @@ 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("cat","catrp100","ws","wsrp100"))
+            expect_equal(params,c("cat","catrp100","other","ws","wsrp100"))
           })
 
 test_that("sc_get_params for name parameters", {