Add search function proposed by @wilsonsj100

Author: bpbond

.Rbuildignore

@@ -4,3 +4,4 @@
 ^codecov\.yml$
 ^LICENSE\.md$
 ^misc$
+^data-raw$

DESCRIPTION

@@ -13,7 +13,8 @@ License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.3
-Depends: R (>= 3.4.0)
+Depends: 
+    R (>= 3.5)
 Imports:
     readr,
     fpeek,
@@ -26,3 +27,4 @@ Suggests:
     covr,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+LazyData: true

NAMESPACE

@@ -14,6 +14,7 @@ export(read_file_dropbox)
 export(read_sapflow_file)
 export(read_teros_file)
 export(scan_folders)
+export(search_Lx_variables)
 import(dplyr)
 import(fpeek)
 importFrom(arrow,read_parquet)

R/read_Lx_variable.R R/Lx_variables.RR/read_Lx_variable.R renamed to R/Lx_variables.R

@@ -104,3 +104,25 @@ read_L2_variable <- function(variable, path, site = NULL, quiet = FALSE) {
     })
     bind_rows(x)
 }
+
+#' Search the list of COMPASS-FME sensor variables
+#'
+#' @param term Search term, case insensitive (character)
+#'
+#' @returns Variables whose descriptions match the search term.
+#' @export
+#' @note The search is case-sensitive but definitely not 'smart';
+#' use single words only!
+#' @examples
+#' search_Lx_variables("redox")
+#' search_Lx_variables("this will not find any matches")
+search_Lx_variables <- function(term) {
+    hits <- grep(tolower(term),
+                 tolower(compasstools::Lx_variables$description),
+                 fixed = TRUE)
+    if(length(hits) > 0) {
+        compasstools::Lx_variables[hits,]
+    } else {
+        message("No matches found")
+    }
+}

R/data.R

@@ -0,0 +1,17 @@
+#' COMPASS-FME sensor data variables
+#'
+#' A listing of the data variables (the "research names")
+#' output by the COMPASS-FME sensor data processing pipeline.
+#'
+#' @format ## `Lx_variables`
+#' A data frame with 154 rows and 2 columns:
+#' \describe{
+#'   \item{research_name}{Name of the output variable}
+#'   \item{final_units}{Units}
+#'   \item{description}{Description}
+#' }
+#' @source See https://github.com/COMPASS-DOE/sensor-data-pipeline
+#' @references Pennington et al. (2025), "A Performant, Scalable Processing
+#' Pipeline for High-Quality and FAIR Environmental Sensor
+#' Data". https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2025JG008807
+"Lx_variables"

data-raw/Lx_variables.R

@@ -0,0 +1,8 @@
+## code to prepare `Lx_variables` dataset goes here
+
+# `variables_metadata.csv` is direct from the
+# sensor data processing pipeline
+Lx_variables <- readr::read_csv("data-raw/variables_metadata.csv")
+Lx_variables <- Lx_variables[c("research_name", "final_units", "description")]
+
+usethis::use_data(Lx_variables, overwrite = TRUE)