v2.1+

nickpoison · Apr 2, 2024 · a2e71ec · a2e71ec
1 parent 1ead8cf
commit a2e71ec
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -31,11 +31,13 @@ remotes::install_github("nickpoison/astsa/astsa_build")
 
 ### Version 2.1 - Jan 2024 (on CRAN)
 
-- after submission, in `mvspec` set `fxx` to `NULL` in univariate case ... and
+#### after v2.1 submission: 
 
-- added `gtemp.month` (monthly global data 1975-2023)
+- in `mvspec` set `fxx` to `NULL` in univariate case ... and in the call, if `demean=TRUE` (default is `FALSE`) `detrend` is set to `FALSE`; i.e., `demean=TRUE` sets `detrend=FALSE`.
 
-#### changes after v2.0
+- added `gtemp.month` (monthly global data 1975-2023) -- rows are month, columns are year to make it easy to plot as monthly functional data
+
+#### v.20 to v2.1:
 
 - added `SV.mle` to fit an SV model [with feedback (aka leverage) if desired] via quasi-MLE. Details are in the help file.  `SVfilter` is now part of `SV.mle` and the original script is now in the xBox as `xSVfilter`.
 

diff --git a/astsa_2.1.tar.gz b/astsa_2.1.tar.gz
diff --git a/astsa_build/R/mvspec.R b/astsa_build/R/mvspec.R
@@ -28,6 +28,7 @@ mvspec <- function(x, spans = NULL, kernel = NULL, taper = 0, pad = 0, fast = TR
         }	
     if (!is.null(kernel) && !is.tskernel(kernel)) 
         stop("must specify 'spans' or a valid kernel")
+    if (demean) detrend = FALSE
     if (detrend) {
         for (i in 1:nser) x[,i] = detrend(x[,i], lowess=lowess) 
     }

diff --git a/astsa_build/man/mvspec.Rd b/astsa_build/man/mvspec.Rd
@@ -25,9 +25,9 @@ mvspec(x, spans = NULL, kernel = NULL, taper = 0, pad = 0, fast = TRUE,
 }
   \item{demean }{if TRUE, series is demeaned first 
 }
-  \item{detrend }{if TRUE, series is detrended first 
+  \item{detrend }{if TRUE, series is detrended first (unless demean is TRUE)
 }
-  \item{lowess }{if TRUE and detrend TRUE, series is detrended using lowess first 
+  \item{lowess }{if TRUE and detrend TRUE (and demean FALSE), series is detrended using lowess first 
 }
   \item{log }{if \code{log='y'}, spectra plotted on a log scale; otherwise a log scale is not used
 }