From dbc4ebd0df036fe8c265b0f76ba3a05a0c3eb49a Mon Sep 17 00:00:00 2001 From: Georgi Boshnakov Date: Thu, 24 Oct 2024 17:47:36 +0100 Subject: [PATCH] fix issue #1 --- DESCRIPTION | 7 +++---- NEWS.md | 14 ++++++++++++++ R/fit_mixARreg.R | 2 +- R/mixAR.R | 4 ++-- man/MixAR-class.Rd | 2 +- man/mixAR-internal.Rd | 9 +-------- man/mixAR-package.Rd | 33 +++++++++++++++++++++++++++++---- 7 files changed, 51 insertions(+), 20 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 05b9e44..ad745a5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,7 @@ Package: mixAR Type: Package Title: Mixture Autoregressive Models -Version: 0.22.7.9000 -Date: 2022-05-05 +Version: 0.22.8.9000 Authors@R: c( person(given = c("Georgi", "N."), family = "Boshnakov", role = c("aut", "cre"), @@ -26,8 +25,8 @@ Imports: stats, graphics, utils, stats4, BB, combinat, timeDate, permute, mvtnorm Suggests: fma, testthat, covr RdMacros: Rdpack -URL: https://geobosh.github.io/mixAR/ (website), - https://github.com/GeoBosh/mixAR/ (devel) +URL: https://geobosh.github.io/mixAR/ (doc), + https://github.com/GeoBosh/mixAR/ (devel) BugReports: https://github.com/GeoBosh/mixAR/issues Collate: raggedCoef.R raggedCoefS.R mixComp.R mixAR.R mixARcalc.R mixutil.R dist.R predict.R mix_se.R obs_info_matrix.R diff --git a/NEWS.md b/NEWS.md index a2be1f4..400f54c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,17 @@ +# mixAR 0.22.8.9000 (CRAN) + +- fixed a typo in a `stop()` string + (fixes issue #1, reported by @beliavski). + + +# mixAR 0.22.8 (CRAN) + +- fixed 'Lost braces' NOTE on CRAN. + +- fixed "Documented arguments not in \usage in Rd file 'mixAR-internal.Rd':" + NOTE on CRAN. + + # mixAR 0.22.7 (CRAN) - fixed CRAN warning "`\item` in `\describe` must have non-empty label" in a diff --git a/R/fit_mixARreg.R b/R/fit_mixARreg.R index a8715de..b26b029 100644 --- a/R/fit_mixARreg.R +++ b/R/fit_mixARreg.R @@ -2,7 +2,7 @@ ## It has been automatically generated from mixAR.org. fit_mixARreg <- function(x, y, mixARmodel, EMinit, ...){ - stop("There is currently no default for this funciton") + stop("There is currently no default for this function") } setGeneric("fit_mixARreg") diff --git a/R/mixAR.R b/R/mixAR.R index f657bc3..f641868 100644 --- a/R/mixAR.R +++ b/R/mixAR.R @@ -867,7 +867,7 @@ setMethod("fit_mixAR", signature(x = "ANY", model = "MixARGaussian", init = "Mix }) # build_mixAR <- function(x, ncomp = 2, pmax = 2, ...){ -# # stop("There is currently no default for this funciton") +# # stop("There is currently no default for this function") # if(ncomp < 2) # ncomp <- 2 # @@ -1288,7 +1288,7 @@ setMethod("show_diff", signature(model1="MixARGaussian", model2="MixARgen"), invisible("") }) - # 2012-11-02 new arg. 'drop' +# 2012-11-02 new arg. 'drop' parameters <- function(model, namesflag = FALSE, drop = character(0)){ coef(model) } diff --git a/man/MixAR-class.Rd b/man/MixAR-class.Rd index eb84354..2778985 100644 --- a/man/MixAR-class.Rd +++ b/man/MixAR-class.Rd @@ -61,7 +61,7 @@ %% ~Make other sections like Warning with \section{Warning }{....} ~ \seealso{ - code{\link{mixAR}}, + \code{\link{mixAR}}, classes \code{"\linkS4class{MixARGaussian}"}, \code{"\linkS4class{MixARgen}"} } diff --git a/man/mixAR-internal.Rd b/man/mixAR-internal.Rd index 71db51d..28d4b34 100644 --- a/man/mixAR-internal.Rd +++ b/man/mixAR-internal.Rd @@ -19,15 +19,8 @@ param_score_stdt(x, nu) } \arguments{ - \item{nu}{~~ TODO: describe this argument. ~~} - \item{p}{~~ TODO: describe this argument. ~~} - \item{value}{~~ TODO: describe this argument. ~~} \item{x}{~~ TODO: describe this argument. ~~} - \item{tau}{~~ TODO: describe this argument. ~~} - \item{etk}{~~ TODO: describe this argument. ~~} - \item{parscore}{~~ TODO: describe this argument. ~~} - \item{sigma}{~~ TODO: describe this argument. ~~} - \item{logpdf}{~~ TODO: describe this argument. ~~} + \item{nu}{~~ TODO: describe this argument. ~~} } \details{ These are not to be called by the user (or in some cases are just diff --git a/man/mixAR-package.Rd b/man/mixAR-package.Rd index 465aed6..78ec493 100644 --- a/man/mixAR-package.Rd +++ b/man/mixAR-package.Rd @@ -2,6 +2,16 @@ \alias{mixAR-package} %\alias{mixAR} \docType{package} + +\concept{mixture autoregressive model} +\concept{MAR model} +\concept{TMAR model} +\concept{mixture autoregression} + +\concept{non-gaussian time series} +\concept{asymmetry in time series} +\concept{multi-modality in time series} + % attaching the package is not necessary for this file but it ensures % that Sexpr's using functions from the package will work also in other % Rd files, without them needing to attach the package. This is @@ -236,10 +246,25 @@ Maintainer: \Sexpr[stage=build]{pd$Maintainer} \insertRef{WongLi2001b}{mixAR} } -% \seealso{ -% ~~ Optional links to other man pages, e.g. ~~ -% ~~ \code{\link[:-package]{}} ~~ -% } +\seealso{ + fit several types of mixAR models: + \code{\link{fit_mixAR}}, \code{\link{bayes_mixAR}}, + \code{\link{fit_mixARreg}}, + \code{\link{mixSARfit}}; + + Predictive distributions and summaries: + \code{\link{mix_pdf}}, \code{\link{mix_cdf}}, \code{\link{mix_qf}}, + \code{\link{mix_location}}, + \code{\link{mix_variance}}, + \code{\link{mix_central_moment}}, + \code{\link{mix_moment}}, + \code{\link{mix_kurtosis}}, + \code{\link{mix_ekurtosis}} + + multi-step prediction: + \code{\link{multiStep_dist}} + +} \examples{ ## object 'exampleModels' contains a number of models for examples and testing names(exampleModels)