From 2f8d2f73848e16a026df8b271c269aedd7d7ae20 Mon Sep 17 00:00:00 2001 From: l-ramirez-lopez Date: Wed, 4 Sep 2024 10:56:56 +0200 Subject: [PATCH] doc: clarify matrix #69 --- R/prospectr.R | 2 ++ R/spliceCorrection.R | 2 +- man/prospectr-package.Rd | 3 +++ man/spliceCorrection.Rd | 2 +- 4 files changed, 7 insertions(+), 2 deletions(-) diff --git a/R/prospectr.R b/R/prospectr.R index 55ca475..12237ac 100644 --- 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 index 2d234fd..59cbdbe 100644 --- 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 index a46a403..6422bec 100644 --- a/man/prospectr-package.Rd +++ b/man/prospectr-package.Rd @@ -15,6 +15,9 @@ This package implements a number of functions useful for pre-processing spectral data well as for selecting representative samples/spectra. 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/man/spliceCorrection.Rd b/man/spliceCorrection.Rd index ba0f04a..1805f51 100644 --- a/man/spliceCorrection.Rd +++ b/man/spliceCorrection.Rd @@ -9,7 +9,7 @@ spliceCorrection(X, wav, splice = c(1000, 1830), interpol.bands = 10) \arguments{ \item{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.} \item{wav}{A numeric vector representing the band positions (e.g. wavelengths) corresponding to the spectral data.}