From 3ac9c01c9594b6cb71d4247764e159afe5bff11c Mon Sep 17 00:00:00 2001
From: AQLT <alain.quartier@yahoo.fr>
Date: Sun, 12 Nov 2023 17:47:25 +0100
Subject: [PATCH 1/2] documentation

---
 R/tests_seasonality.R           | 14 ++++++++------
 man/seasonality_canovahansen.Rd |  4 ++--
 man/seasonality_combined.Rd     |  6 ++++--
 3 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/R/tests_seasonality.R b/R/tests_seasonality.R
index 2e9c9a8..106e8a3 100644
--- a/R/tests_seasonality.R
+++ b/R/tests_seasonality.R
@@ -109,7 +109,9 @@ seasonality_f<-function(data,
 #' "X12" Test On Seasonality
 #'
 #' @inheritParams seasonality_qs
-#' @param firstperiod First period of the series (1-based)
+#' @param firstperiod Position in a cycle of the first obs.
+#' For example, for a monthly, `firstperiod = 1` means January.
+#' If `data` is not a `"ts"` object, `firstperiod = 1` by default.
 #' @param mul boolean indicating if the seasonal decomposition is multiplicative (`mul = TRUE`) or additive (`mul = FALSE`).
 #' @details Combined test on the presence of identifiable seasonality (see Ladiray and Quenneville, 1999).
 #' @export
@@ -117,7 +119,7 @@ seasonality_f<-function(data,
 #' @examples
 #' seasonality_combined(ABS$X0.2.09.10.M, 12)
 #' seasonality_combined(random_t(2, 1000), 7)
-seasonality_combined<-function(data, period, firstperiod=1, mul=TRUE){
+seasonality_combined<-function(data, period, firstperiod=cycle(data)[1], mul=TRUE){
   if (is.ts(data) & missing(period))
     period <- frequency(data)
   jctest<-.jcall("jdplus/sa/base/r/SeasonalityTests", "Ljdplus/sa/base/core/tests/CombinedSeasonality;", "combinedTest",
@@ -134,10 +136,10 @@ seasonality_combined<-function(data, period, firstperiod=1, mul=TRUE){
 #' Seasonal Canova-Hansen test
 #'
 #' @inheritParams seasonality_qs
-#' @param p0 Initial periodicity (included)
-#' @param p1 Final periodicity (included)
-#' @param np Number of periodicities equally spaced in $\[p0,p1\]$
-#' @param original True for original algorithm, False for solution proposed by T. Proietti (based on Ox code)
+#' @param p0 Initial periodicity (included).
+#' @param p1 Final periodicity (included).
+#' @param np Number of periodicities equally spaced in \eqn{[p_0,p_1]}.
+#' @param original `TRUE` for original algorithm, `FALSE` for solution proposed by T. Proietti (based on Ox code).
 #'
 #' @export
 #'
diff --git a/man/seasonality_canovahansen.Rd b/man/seasonality_canovahansen.Rd
index 3a4daca..89854f3 100644
--- a/man/seasonality_canovahansen.Rd
+++ b/man/seasonality_canovahansen.Rd
@@ -13,9 +13,9 @@ seasonality_canovahansen(data, p0, p1, np, original = FALSE)
 
 \item{p1}{Final periodicity (included)}
 
-\item{np}{Number of periodicities equally spaced in $[p0,p1]$}
+\item{np}{Number of periodicities equally spaced in \eqn{[p_0,p_1]}.}
 
-\item{original}{True for original algorithm, False for solution proposed by T. Proietti (based on Ox code)}
+\item{original}{\code{TRUE} for original algorithm, \code{FALSE} for solution proposed by T. Proietti (based on Ox code)}
 }
 \description{
 Seasonal Canova-Hansen test
diff --git a/man/seasonality_combined.Rd b/man/seasonality_combined.Rd
index 337adeb..dcd763e 100644
--- a/man/seasonality_combined.Rd
+++ b/man/seasonality_combined.Rd
@@ -4,14 +4,16 @@
 \alias{seasonality_combined}
 \title{"X12" Test On Seasonality}
 \usage{
-seasonality_combined(data, period, firstperiod = 1, mul = TRUE)
+seasonality_combined(data, period, firstperiod = cycle(data)[1], mul = TRUE)
 }
 \arguments{
 \item{data}{the input data.}
 
 \item{period}{Tested periodicity.}
 
-\item{firstperiod}{First period of the series (1-based)}
+\item{firstperiod}{Position in a cycle of the first obs.
+For example, for a monthly, \code{firstperiod = 1} means January.
+If \code{data} is not a \code{"ts"} object, \code{firstperiod = 1} by default.}
 
 \item{mul}{boolean indicating if the seasonal decomposition is multiplicative (\code{mul = TRUE}) or additive (\code{mul = FALSE}).}
 }

From 20c950f19899456f910591184a7c8c5fdafd9a93 Mon Sep 17 00:00:00 2001
From: AQLT <alain.quartier@yahoo.fr>
Date: Sun, 12 Nov 2023 17:50:28 +0100
Subject: [PATCH 2/2] doc

---
 man/seasonality_canovahansen.Rd | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/man/seasonality_canovahansen.Rd b/man/seasonality_canovahansen.Rd
index 89854f3..32ec704 100644
--- a/man/seasonality_canovahansen.Rd
+++ b/man/seasonality_canovahansen.Rd
@@ -9,13 +9,13 @@ seasonality_canovahansen(data, p0, p1, np, original = FALSE)
 \arguments{
 \item{data}{the input data.}
 
-\item{p0}{Initial periodicity (included)}
+\item{p0}{Initial periodicity (included).}
 
-\item{p1}{Final periodicity (included)}
+\item{p1}{Final periodicity (included).}
 
 \item{np}{Number of periodicities equally spaced in \eqn{[p_0,p_1]}.}
 
-\item{original}{\code{TRUE} for original algorithm, \code{FALSE} for solution proposed by T. Proietti (based on Ox code)}
+\item{original}{\code{TRUE} for original algorithm, \code{FALSE} for solution proposed by T. Proietti (based on Ox code).}
 }
 \description{
 Seasonal Canova-Hansen test