Merge pull request #124 from AQLT/master

Doc update for CRAN release

.Rbuildignore

@@ -14,3 +14,4 @@ TO_DO
 ^revdep$
 ^\.github$
 .DS_Store
+^reconf\.sh$

R/regarima_specTS.R

@@ -172,15 +172,15 @@
 #' and no further attempt will be made to identify another model.
 #'
 #' @param automdl.cancel \code{numeric}, the cancellation limit. If the difference in moduli of an AR and an MA roots (when estimating ARIMA(1,0,1)(1,0,1) models
-#' in the second step of the automatic identification of the differencing orders) is smaller than the cancellation limit, the two roots are assumed equal and cancelled out.
+#' in the second step of the automatic identification of the differencing orders) is smaller than the cancellation limit, the two roots are assumed equal and canceled out.
 #'
 #' @param automdl.ub1 \code{numeric}, the first unit root limit. It is the threshold value for the initial unit root test in the automatic differencing procedure.
 #' When one of the roots in the estimation of the ARIMA(2,0,0)(1,0,0) plus mean model, performed in the first step of the automatic model identification procedure,
 #' is larger than first unit root limit in modulus, it is set equal to unity.
 #'
 #' @param automdl.ub2 \code{numeric}, the second unit root limit. When one of the roots in the estimation of the ARIMA(1,0,1)(1,0,1) plus mean model,
 #' which is performed in the second step of the automatic model identification procedure, is larger than second unit root limit in modulus,
-#' it is checked if there is a common factor in the corresponding AR and MA polynomials of the ARMA model that can be cancelled (see \code{automdl.cancel}).
+#' it is checked if there is a common factor in the corresponding AR and MA polynomials of the ARMA model that can be canceled (see \code{automdl.cancel}).
 #' If there is no cancellation, the AR root is set equal to unity (i.e. the differencing order changes).
 #'
 #' @param automdl.armalimit \code{numeric}, the arma limit. It is the threshold value for t-statistics of ARMA coefficients and the constant term used
@@ -196,7 +196,7 @@
 #' If the LjungBox Q statistics for the residuals of a final model is greater than Ljung Box limit, then the model is rejected, the outlier critical value is reduced,
 #' and model and outlier identification (if specified) is redone with a reduced value.
 #'
-#' @param automdl.compare \code{logical}. If {TRUE}, the program compares the model identified by the automatic procedure to the default model (ARIMA(0,1,1)(0,1,1))
+#' @param automdl.compare \code{logical}. If \code{TRUE}, the program compares the model identified by the automatic procedure to the default model (ARIMA(0,1,1)(0,1,1))
 #' and the model with the best fit is selected. Criteria considered are residual diagnostics, the model structure and the number of outliers.
 #'
 #' Control variables for the non-automatic modelling of the ARIMA model (\code{automdl.enabled} is set to \code{FALSE}):
@@ -265,7 +265,7 @@
 #' The final specification (third row) shall include user modifications (row two) unless they were wrongly specified.
 #' The pre-specified outliers, user-defined variables and pre-specified ARMA coefficients consist of a list
 #' with the \code{Predefined} (base model specification) and \code{Final} values.
-#'\itemize{
+#'
 #' \item{estimate}{a data frame containing Variables referring to: \code{span} - time span to be used for the estimation,
 #' \code{tolerance} - argument \code{estimate.tol}, \code{exact_ml} - argument \code{estimate.eml}, \code{urfinal} - argument \code{esimate.urfinal}.
 #' The final values can be also accessed with the function \code{\link{s_estimate}}.}
@@ -323,7 +323,7 @@
 #' \item{span}{a matrix containing the final time span for the model estimation and outliers' detection.
 #' It contains the same information as the variable span in the data frames estimate and outliers.
 #' The matrix can be also accessed with the function \code{\link{s_span}}.}
-#'}
+#'
 #' @references
 #' More information and examples related to 'JDemetra+' features in the online documentation:
 #' \url{https://jdemetra-new-documentation.netlify.app/}

R/regarima_specX13.R

@@ -141,7 +141,7 @@
 #' It can be combined with the parameter \code{outlier.exclLast}.
 #'
 #' @param outlier.exclLast a numeric specifying the number of periods excluded at the end of the series.
-#' It can be combined with the paramter \code{outlier.exclFirst}.
+#' It can be combined with the parameter \code{outlier.exclFirst}.
 #'
 #' @param outlier.ao a logical. If \code{TRUE}, the automatic detection of additive outliers is enabled
 #' (\code{outlier.enabled} must be also set to \code{TRUE}).
@@ -188,7 +188,7 @@
 #' @param automdl.ub2 the second unit root limit (\code{numeric}). When one of the roots in the estimation of
 #' the ARIMA(1,0,1)(1,0,1) plus mean model, which is performed in the second step of the automatic model identification
 #' procedure, is larger than second unit root limit in modulus, it is checked if there is a common factor
-#' in the corresponding AR and MA polynomials of the ARMA model that can be cancelled (see \code{automdl.cancel}).
+#' in the corresponding AR and MA polynomials of the ARMA model that can be canceled (see \code{automdl.cancel}).
 #' If there is no cancellation, the AR root is set equal to unity (i.e. the differencing order changes).
 #'
 #' @param automdl.mixed a logical. This variable controls whether ARIMA models with non-seasonal AR and MA terms
@@ -243,7 +243,7 @@
 #'
 #' @param arima.coefEnabled logical. If \code{TRUE}, the program uses the user-defined ARMA coefficients.
 #'
-#' @param arima.coef a vector providing the coefficients for the regular and seasonal AR and MA polynominals.
+#' @param arima.coef a vector providing the coefficients for the regular and seasonal AR and MA polynomials.
 #' The vector length must be equal to the sum of the regular and seasonal AR and MA orders.
 #' The coefficients shall be provided in the following order: regular AR (\emph{Phi}; \code{p} elements),
 #' regular MA  (\emph{Theta}; \code{q} elements), seasonal AR (\emph{BPhi}; \code{bp} elements)

R/tramoseats_spec.R

@@ -66,10 +66,10 @@
 #' The pre-specified outliers, user-defined variables and pre-specified ARMA coefficients consist of a list of
 #' \code{Predefined} (base model specification) and \code{Final} values.
 #'
-#' \item{regarima}{an object of class \code{c("regarima_spec", "TRAMO_SEATS")}. See \emph{Value} of the function \code{\link{regarima_spec_tramoseats}}.}
+#' \item \code{regarima}: an object of class \code{c("regarima_spec", "TRAMO_SEATS")}. See \emph{Value} of the function \code{\link{regarima_spec_tramoseats}}.
 #'
-#' \item{seats}{a data.frame of class \code{c("seats_spec", "data.frame")}, containing the \emph{seats} variables in line with
-#' the names of the arguments variables. The final values can also be accessed with the function \code{\link{s_seats}}.}
+#' \item \code{seats}: a data.frame of class \code{c("seats_spec", "data.frame")}, containing the \emph{seats} variables in line with
+#' the names of the arguments variables. The final values can also be accessed with the function \code{\link{s_seats}}.
 #'}
 #' @references
 #' More information and examples related to 'JDemetra+' features in the online documentation:

R/x13_spec.R

@@ -75,10 +75,10 @@
 #' The pre-specified outliers, user-defined variables and pre-specified ARMA coefficients consist of a list of
 #' \code{Predefined} (base model specification) and \code{Final} values.
 #'
-#' \item{regarima}{an object of class \code{c("regarima_spec", "x13")}. See \emph{Value} of the function \code{\link{regarima_spec_x13}}.}
+#' \item \code{regarima}: an object of class \code{c("regarima_spec", "x13")}. See \emph{Value} of the function \code{\link{regarima_spec_x13}}.
 #'
-#' \item{x11}{a data.frame of class \code{c("X11_spec", "data.frame")}, containing the \emph{x11} variables in line with
-#' the names of the arguments variables. The final values can be also accessed with the function \code{\link{s_x11}}.}
+#' \item \code{x11}: a data.frame of class \code{c("X11_spec", "data.frame")}, containing the \emph{x11} variables in line with
+#' the names of the arguments variables. The final values can be also accessed with the function \code{\link{s_x11}}.
 #'}
 #' @references
 #' More information and examples related to 'JDemetra+' features in the online documentation: