added find_mrs_files function

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: spant
 Type: Package
 Title: MR Spectroscopy Analysis Tools
-Version: 2.15.9000
-Date: 2023-08-03
+Version: 2.15.0
+Date: 2023-09-14
 Authors@R: c(
     person("Martin", "Wilson", email = "[email protected]",
            role = c("cre", "aut"), comment = c(ORCID = "0000-0002-2089-3956")),

NEWS.md

@@ -1,6 +1,7 @@
 # spant 2.15.0
 * An SNR estimate of zero in comb_coils is now a failure case.
 * Bug fix for GE pfile reader header revision 20.
+* Added a function for finding valid MRS files : find_mrs_files.
 
 # spant 2.14.0
 * Added vline argument to stackplot function.

R/utils.R

@@ -1,3 +1,30 @@
+#' Find valid MRS data files recursively from a directory path.
+#' @param dir a directory path.
+#' @return a vector of valid MRS data files.
+#' @examples
+find_mrs_files <- function(dir) {
+
+  # recursively find all files
+  all_files <- list.files(dir, recursive = TRUE, full.names = TRUE)
+
+  # empty vector of found files
+  mrs_files <- c()
+
+  # check each file, catching any errors
+  for (file in all_files) {
+    tryCatch(
+      {
+        dummy <- read_mrs(file)
+        mrs_files <- c(mrs_files, file)
+      },
+      error = function(cond) {
+      }
+    )
+  }
+  return(mrs_files)
+}
+
+
 #' Apply a function over specified array axes.
 #' @param x an array.
 #' @param axes a vector of axes to apply fun over.