Additional bug fixing and corrected documentation

Author: Shawn P. Serbin

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: FieldSpectra
 Type: Package
 Title: Functions for processing field spectroscopy data
-Version: 0.9222
-Date: 2020-12-08
+Version: 0.9.5
+Date: 2020-12-09
 Author: Shawn P. Serbin
 Maintainer: Shawn P. Serbin <sserbin@bnl.gov>
 Description: A field spectroscopy package containing functions to process
@@ -26,4 +26,4 @@ Copyright: Authors
 LazyLoad: yes
 LazyData: FALSE
 Encoding: UTF-8
-RoxygenNote: 6.1.1
+RoxygenNote: 7.1.1

FieldSpectra_0.9.5.pdf

@@ -1,3 +1,5 @@
+# Generated by roxygen2: do not edit by hand
+
 export(average.spec)
 export(average.spec.se)
 export(concat.spectra)

FieldSpectra_0.9222.pdf

@@ -146,7 +146,7 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   jc.files <- list.files(path=file.dir,pattern=output.file.ext,
                             full.names=FALSE)
   jc.files <- jc.files[-grep(pattern="Diagnostic",jc.files)]
-  num.files  = length(jc.files)
+  num.files <- length(jc.files)
 
   ### Check whether files exist. STOP if files missing and display an error
   if (num.files<1){
@@ -188,9 +188,7 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   }
 
   ### Display info to console
-  tmp  = unlist(strsplit(file.dir,dlm))
-  current = tmp[length(tmp)]
-  print(paste("----- Processing directory: ",current) )
+  print(paste("----- Processing directory: ",file.dir) )
   flush.console() #<--- show output in real-time
 
   j <- 1 # <--- Numeric counter for progress bar
@@ -234,7 +232,7 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   dims <- dim(good.spec)
 
   ### Update diagnostic info
-  for (i in 1:dim(in.spec3)[1]) {
+  for (i in seq_along(1:dim(in.spec3)[1])) {
     info[i,1] <- as.character(in.spec3[i,1])
     if (as.character(in.spec3[i,1]) %in% as.character(bad.spec[,1])) {
       info[i,2] <- "Failed"
@@ -250,8 +248,9 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   flush.console()                                #<--- show output in real-time
 
   ##### Initial average
-  ind <- factor(as.numeric(good.spec$Spectra))
-  mat.data <- as.matrix(good.spec[,3:dims[2]])
+  #ind <- factor(as.numeric(good.spec$Spectra))
+  ind <- factor(good.spec$Spectra)
+  mat.data <- as.matrix(good.spec[,3:dim(good.spec)[2]])
   if (dim(mat.data)[1]==0){
     stop("******** ERROR: Bias threshold too strict, no remaining spectra to average. Please correct ********")
   }
@@ -266,25 +265,21 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   names(spec.avg) <- c("Spectra",waves)
 
   ### Get spectra sdev
-  dims <- dim(good.spec)
-  spec.sdev <- aggregate(.~Spectra,data=good.spec[,2:dims[2]],sd,simplify=TRUE)
-  spec.sdev[is.na(spec.sdev)]=0
+  spec.sdev <- aggregate(.~Spectra,data=good.spec[,2:dim(good.spec)[2]],sd,simplify=TRUE)
+  spec.sdev[is.na(spec.sdev)] <- 0
   spec.avg.names <- spec.avg$Spectra
-  dims <- dim(spec.avg)
   rm(mat.data,ind)
 
   # Debug
   #plot(seq(350,2500,1),unlist(spec.sdev[9,2:dim(spec.sdev)[2]]),ylim=c(0,0.04),type="l")
 
-  
   ### Setup spectral checks
   dims <- dim(spec.avg)
-  n <- rle(as.numeric(good.spec$Spectra))$lengths
-  spec.upper <- spec.avg[,2:dims[2]] + (spec.sdev[,2:dims[2]]*outlier.cutoff) # 2*SD outlier check
-  #spec.upper <- spec.avg[,2:dims[2]] + ((spec.sdev[,2:dims[2]]/sqrt(n))*2.96)
+  #n <- rle(as.numeric(good.spec$Spectra))$lengths
+  n <- rle(good.spec$Spectra)$lengths
+  spec.upper <- spec.avg[,2:dim(spec.avg)[2]] + (spec.sdev[,2:dim(spec.avg)[2]]*outlier.cutoff) # 2*SD outlier check
   spec.upper <- data.frame(Spectra=spec.avg.names,spec.upper)
-  spec.lower <- spec.avg[,2:dims[2]] - (spec.sdev[,2:dims[2]]*outlier.cutoff)
-  #spec.lower <- spec.avg[,2:dims[2]] - ((spec.sdev[,2:dims[2]]/sqrt(n))*2.96)
+  spec.lower <- spec.avg[,2:dim(spec.avg)[2]] - (spec.sdev[,2:dim(spec.avg)[2]]*outlier.cutoff)
   spec.lower <- data.frame(Spectra=spec.avg.names,spec.lower)
 
   ### For debugging
@@ -300,11 +295,12 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   flush.console()                                #<--- show output in real-time
 
   # Do second sdev check of spectra
-  ind <- as.numeric(good.spec$Spectra)
+  #ind <- as.numeric(good.spec$Spectra)
+  ind <- good.spec$Spectra
   good.spec2 <- as.matrix(good.spec[,-c(1,2)])
   spec.upper <- as.matrix(spec.upper[,-1])
   spec.lower <- as.matrix(spec.lower[,-1])
-  for (i in 1:length(ind)){
+  for (i in seq_along(1:length(ind))) {
     ind.avg <- ind[i]
     orig.spec.name <- good.spec[i,1]
     # run check of individual spectra against the group mean
@@ -318,8 +314,8 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
       window <- 151:1351 # 500 - 1700
     } else if (spec.type=="Canopy") {
       #window <- c(151:1441) # 500 - 1790
-      window <- c(151:1441,1671:1901)
-    } 
+      window <- c(151:1000, 1080:1441, 1671:1901)
+    }
     if (any(good.spec2[i,window]>spec.upper[ind.avg,window]) || 
       any(good.spec2[i,window] < spec.lower[ind.avg,window])) {
       bad.spec <- rbind(bad.spec,good.spec[i,])
@@ -344,8 +340,9 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   ### Create final spectral averages
   rm(spec.avg)
   #spec.avg <- aggregate(.~Spectra,data=good.spec,mean,simplify=TRUE)
-  ind <- factor(as.numeric(good.spec$Spectra))
-  mat.data <- as.matrix(good.spec[,2:dims[2]])
+  #ind <- factor(as.numeric(good.spec$Spectra))
+  ind <- factor(good.spec$Spectra)
+  mat.data <- as.matrix(good.spec[,2:dim(good.spec)[2]])
   spec.avg <- mApply(mat.data,ind,colMeans,simplify=TRUE)
   ### Reformat spectral data for output
   if (is.null(dim(spec.avg)[1])){
@@ -360,24 +357,23 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   flush.console()                                #<--- show output in real-time
 
   ### Output bad spectra files and figs
-  dims <- dim(bad.spec)
-  if (dims[1]>0){
-    for (i in 1:dims[1]){
-      spec.name <- droplevels(bad.spec[i,1])
-      out.spec <- t(bad.spec[i,3:dims[2]])
+  if (dim(bad.spec)[1]>0){
+    for (i in seq_along(1:dim(bad.spec)[1])) {
+      spec.name <- as.character(bad.spec[i,1])
+      out.spec <- t(bad.spec[i,3:dim(bad.spec)[2]])
       out.spec <- data.frame(Wavelength=seq(start.wave,end.wave,step.size),
                              Spectra=out.spec)
-      names(out.spec)=c("Wavelength",paste(spec.name))
-      out.filename <- paste(droplevels(bad.spec[i,1]),output.file.ext,sep="")
-      write.csv(out.spec,paste(badspec.dir,dlm,out.filename,sep=""),row.names=FALSE)
+      names(out.spec) <- c("Wavelength",paste(spec.name))
+      out.filename <- paste(as.character(bad.spec[i,1]),output.file.ext,sep="")
+      write.csv(x = out.spec,file = file.path(badspec.dir,out.filename),row.names=FALSE)
 
       # Output plot of bad spectra for quick reference
-      if(image=="TRUE" | settings.file$options$diagnostic.images=="TRUE"){
+      if(image=="TRUE" | settings.file$options$diagnostic.images=="TRUE") {
         rng <- range(out.spec[,2])
         if (rng[1]<0) rng[1] <- 0
         if (rng[2]>1) rng[2] <- 1
         ylimit <- c(rng[1],rng[2])
-        png(file=paste(badspec.dir,dlm,spec.name,".png",sep=""),width=800,height=600,res=100)
+        png(file=file.path(badspec.dir,paste0(spec.name,".png")),width=800,height=600,res=100)
         plot(out.spec[,1], out.spec[,2],cex=0.01,xlim=c(350,2500),ylim=ylimit,xlab="Wavelength (nm)",
            ylab="Reflectance (%)", main=out.filename,cex.axis=1.3,cex.lab=1.3)
         lines(out.spec[,1], out.spec[,2],lwd=2)
@@ -386,20 +382,19 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
         dev.off()
       }
     } 
-    rm(spec.name,out.spec,out.filename,dims)
+    rm(spec.name,out.spec,out.filename)
   } # End of output of bad spectra
 
   # Output good spec
-  dims <- dim(spec.avg)
-  if (dims[1]>0){
-    for (i in 1:dims[1]){
-      spec.name <- droplevels(spec.avg[i,1])
-      out.spec <- t(spec.avg[i,2:dims[2]])
+  if (dim(spec.avg)[1]>0){
+    for (i in seq_along(1:dim(spec.avg)[1])) {
+      spec.name <- as.character(spec.avg[i,1])
+      out.spec <- t(spec.avg[i,2:dim(spec.avg)[2]])
       out.spec <- data.frame(Wavelength=seq(start.wave,end.wave,step.size),
                              Spectra=out.spec)
       names(out.spec)=c("Wavelength",paste(spec.name))
       out.filename <- paste(spec.name,output.file.ext,sep="")
-      write.csv(out.spec,paste(out.dir,dlm,out.filename,sep=""),row.names=FALSE)
+      write.csv(x = out.spec,file = file.path(out.dir,out.filename),row.names=FALSE)
 
       ### Output plot of average spectra for quick reference
       if(image=="TRUE" | settings.file$options$diagnostic.images=="TRUE"){
@@ -420,16 +415,15 @@ average.spec <- function(file.dir=NULL,out.dir=NULL,spec.type="Reflectance",star
   }
 
   ### Write out concatenated averaged spectra
-  write.csv(spec.avg,paste(out.dir,dlm,"Averaged_Spectra",output.file.ext,sep=""),row.names=FALSE)
+  write.csv(x = spec.avg,file = file.path(out.dir,paste0("Averaged_Spectra",output.file.ext)),row.names=FALSE)
 
   ### Output diagnostic info
-  write.csv(info,paste(out.dir,dlm,"Spectra_Diagnostic_Information",".txt",sep=""),row.names=FALSE)
+  write.csv(x = info,file = file.path(out.dir,paste0("Spectra_Diagnostic_Information",".txt")),row.names=FALSE)
 
   ### Output plot of averaged spectra for quick reference
-  dims <- dim(spec.avg)
   if(image=="TRUE" | settings.file$options$diagnostic.images=="TRUE"){
-    if (dims[1]>0){
-      plot.data <- as.matrix(spec.avg[,2:dims[2]])
+    if (dim(spec.avg)[1]>0){
+      plot.data <- as.matrix(spec.avg[,2:dim(spec.avg)[2]])
       png(file=paste(out.dir,dlm,"Averaged_Spectra",".png",sep=""),width=800,height=600,res=100)
       matplot(seq(start.wave,end.wave,step.size), t(plot.data),cex=0.01,xlim=c(350,2500),ylim=c(0,1),
               xlab="Wavelength (nm)",ylab="Reflectance (%)", main="Averaged Spectra",

NAMESPACE

@@ -149,9 +149,7 @@ jump.correction <- function(file.dir=NULL,out.dir=NULL,spec.type=NULL,start.wave
   }
 
   ### Display info to the terminal
-  tmp  <- unlist(strsplit(file.dir,dlm))
-  current <- tmp[length(tmp)]
-  print(paste("------- Processing directory: ",current))
+  print(paste("------- Processing directory: ",file.dir))
   print(paste("------- Number of files: ",num.files))
   flush.console() #<--- show output in real-time
 

R/average.spec.R

@@ -970,10 +970,10 @@ extract.metadata.svc <- function(file.dir,out.dir,spec.file.ext,output.file.ext,
 
 #--------------------------------------------------------------------------------------------------#
 ##'
-##' @name plot.spectra
-##' @title NOT YET IMPLEMENTED
+#@name plot.spectra
+#@title NOT YET IMPLEMENTED
 ##'
-##' @author Shawn P. Serbin
+#@author Shawn P. Serbin
 ##' 
 # plot.spectra <- function(file.dir=NULL,out.dir=NULL,instrument=NULL,out.filename=NULL,
 #                          spec.file.ext=NULL,out.file.ext=".csv",settings.file=NULL){
@@ -1158,6 +1158,7 @@ concat.spectra <- function(file.dir=NULL,out.dir=NULL,out.filename=NULL,in.file.
 #--------------------------------------------------------------------------------------------------#
 ##'
 ##' @name transpose.spectra
+##' 
 ##' @title Transpose spectra file(s) from/to row or column major format.  Works with either a 
 ##' single spectrum or directory of spectral observations.
 ##' 

R/overlap.corrections.R

@@ -41,7 +41,7 @@ plot(seq(350,2500,1),spectra[2,2:dim(spectra)[2]],type="l")
 jump.correction(settings.file=settings)
 
 ### Average spectra
-average.spec(settings.file=settings)
+average.spec(settings.file=settings, spec.type="Reflectance")
 spectra <- average.spec(settings.file=settings) # output a dataframe with the spectra
 
 # Look at spectra