few roxygen edits

nicholasjclark · Nov 8, 2023 · 20bf94f · 20bf94f
1 parent 6c932ef
commit 20bf94f
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 6 deletions.
diff --git a/R/plot_mvgam_factors.R b/R/plot_mvgam_factors.R
@@ -3,7 +3,7 @@
 #'This function takes a fitted \code{mvgam} object and returns plots and summary statistics for
 #'the latent dynamic factors
 #'
-#'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@param plot \code{logical} specifying whether factors should be plotted
 #'@author Nicholas J Clark
 #'@details If the model in \code{object} was estimated using dynamic factors, it is possible that not all factors

diff --git a/R/plot_mvgam_fc.R b/R/plot_mvgam_fc.R
@@ -1,6 +1,6 @@
 #'Plot mvgam posterior predictions for a specified series
 #'@importFrom stats formula terms
-#'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@param series \code{integer} specifying which series in the set is to be plotted
 #'@param newdata Optional \code{dataframe} or \code{list} of test data containing at least 'series' and 'time'
 #'in addition to any other variables included in the linear predictor of the original \code{formula}. If included, the

diff --git a/R/plot_mvgam_pterms.R b/R/plot_mvgam_pterms.R
@@ -5,6 +5,7 @@
 #'@importFrom graphics layout title rug bxp
 #'@importFrom stats coef predict
 #'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@details Posterior empirical quantiles of each parametric term's partial effect estimates
 #'(on the link scale) are calculated and visualised as ribbon plots. These effects can
 #'be interpreted as the partial effect that a parametric term contributes when all other

diff --git a/R/plot_mvgam_randomeffects.R b/R/plot_mvgam_randomeffects.R
@@ -4,6 +4,7 @@
 #'
 #'@importFrom graphics layout title
 #'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@details Posterior empirical quantiles of random effect coefficient estimates
 #'(on the link scale) are calculated and visualised as ribbon plots.
 #'Labels for coefficients are taken from the levels of the original factor variable

diff --git a/R/plot_mvgam_resids.R b/R/plot_mvgam_resids.R
@@ -5,7 +5,7 @@
 #'@importFrom graphics layout title
 #'@importFrom stats complete.cases qqnorm qqline acf pacf na.pass
 #'@importFrom mgcv bam
-#'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@param series \code{integer} specifying which series in the set is to be plotted
 #'@param newdata Optional \code{dataframe} or \code{list} of test data containing at least 'series', 'y', and 'time'
 #'in addition to any other variables included in the linear predictor of \code{formula}. If included, the

diff --git a/R/plot_mvgam_smooth.R b/R/plot_mvgam_smooth.R
@@ -5,6 +5,7 @@
 #'@importFrom grDevices hcl.colors
 #'@importFrom stats quantile predict
 #'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@param series \code{integer} specifying which series in the set is to be plotted
 #'@param smooth either a \code{character} or \code{integer} specifying which smooth term to be plotted
 #'@param residuals \code{logical}. If \code{TRUE} then posterior quantiles of partial residuals are added

diff --git a/R/plot_mvgam_trend.R b/R/plot_mvgam_trend.R
@@ -1,7 +1,7 @@
 #'Plot mvgam latent trend for a specified series
 #'@importFrom graphics par lines polygon box abline
 #'@importFrom stats sd quantile
-#'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@param series \code{integer} specifying which series in the set is to be plotted
 #'@param newdata Optional \code{dataframe} or \code{list} of test data containing at least 'series' and 'time'
 #'in addition to any other variables included in the linear predictor of the original \code{formula}.

diff --git a/R/plot_mvgam_uncertainty.R b/R/plot_mvgam_uncertainty.R
@@ -1,7 +1,7 @@
 #'Plot mvgam forecast uncertainty contributions for a specified series
 #'@importFrom graphics legend
 #'@importFrom stats predict
-#'@inheritParams plot.mvgam
+#'@param object \code{list} object returned from \code{mvgam}. See [mvgam()]
 #'@param series \code{integer} specifying which series in the set is to be plotted
 #'@param newdata A \code{dataframe} or \code{list} containing at least 'series' and 'time' for the forecast horizon, in
 #'addition to any other variables included in the linear predictor of \code{formula}

diff --git a/man/mcmc_plot.mvgam.Rd b/man/mcmc_plot.mvgam.Rd
diff --git a/man/plot_mvgam_factors.Rd b/man/plot_mvgam_factors.Rd
diff --git a/man/plot_mvgam_forecasts.Rd b/man/plot_mvgam_forecasts.Rd
diff --git a/man/plot_mvgam_pterms.Rd b/man/plot_mvgam_pterms.Rd
diff --git a/man/plot_mvgam_randomeffects.Rd b/man/plot_mvgam_randomeffects.Rd
diff --git a/man/plot_mvgam_resids.Rd b/man/plot_mvgam_resids.Rd
diff --git a/man/plot_mvgam_smooth.Rd b/man/plot_mvgam_smooth.Rd
diff --git a/man/plot_mvgam_trend.Rd b/man/plot_mvgam_trend.Rd
diff --git a/man/plot_mvgam_uncertainty.Rd b/man/plot_mvgam_uncertainty.Rd
diff --git a/src/mvgam.dll b/src/mvgam.dll