doc: clarify matrix #69

l-ramirez-lopez · Sep 4, 2024 · 2f8d2f7 · 2f8d2f7
1 parent bb4d5e9
commit 2f8d2f7
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/R/prospectr.R b/R/prospectr.R
@@ -24,6 +24,8 @@
 #' The functions included here are particularly useful in Near-Infrared and Infrared
 #' Spectroscopy applications.
 #'
+#' All the functions are designed to accept spectral data as as matrix where 
+#' rows represent each spectrum and columns the band positions.  
 #' @details
 #' 
 #' #' This is the version 

diff --git a/R/spliceCorrection.R b/R/spliceCorrection.R
@@ -11,7 +11,7 @@
 #'
 #' @param X A numeric matrix of spectra or a vector representing a single 
 #' spectrum to be corrected (optionally a data frame that can be coerced to a 
-#' numeric matrix).
+#' numeric matrix). Rows represent each spectrum and columns the band positions. 
 #' @param wav A numeric vector representing the band positions (e.g. wavelengths)
 #' corresponding to the spectral data.
 #' @param splice A numeric vector of length 1 or 2 specifying the band 

diff --git a/man/prospectr-package.Rd b/man/prospectr-package.Rd
diff --git a/man/spliceCorrection.Rd b/man/spliceCorrection.Rd