From a9c6f5abe08276efd8f59c5002385a0e4b78e894 Mon Sep 17 00:00:00 2001 From: Young Geun Kim Date: Tue, 26 Nov 2024 16:09:15 +0900 Subject: [PATCH] fix missing document --- R/member.R | 23 +++++++++++++++++++++-- _pkgdown.yml | 1 + man/bound_bvhar.Rd | 2 +- man/bvar_flat.Rd | 2 +- man/bvar_minnesota.Rd | 2 +- man/bvhar_minnesota.Rd | 2 +- man/choose_bvar.Rd | 2 +- man/forecast_roll.Rd | 2 +- man/irf.Rd | 2 +- man/predict.Rd | 2 +- man/set_bvar.Rd | 2 +- man/set_dl.Rd | 2 +- man/set_gdp.Rd | 2 ++ man/set_horseshoe.Rd | 2 +- man/set_intercept.Rd | 2 +- man/set_lambda.Rd | 2 +- man/set_ldlt.Rd | 2 +- man/set_ng.Rd | 2 +- man/set_ssvs.Rd | 2 +- man/var_lm.Rd | 2 +- man/vhar_lm.Rd | 2 +- 21 files changed, 42 insertions(+), 20 deletions(-) diff --git a/R/member.R b/R/member.R index 8ec4ab7b..af9c4758 100644 --- a/R/member.R +++ b/R/member.R @@ -122,32 +122,35 @@ fitted.bvharmn <- function(object, ...) { } #' @rdname var_lm -#' @param x A `varlse` object +#' @param x Any object #' @export is.varlse <- function(x) { inherits(x, "varlse") } #' @rdname vhar_lm -#' @param x A `vharlse` object +#' @param x Any object #' @export is.vharlse <- function(x) { inherits(x, "vharlse") } #' @rdname bvar_minnesota +#' @param x Any object #' @export is.bvarmn <- function(x) { inherits(x, "bvarmn") } #' @rdname bvar_flat +#' @param x Any object #' @export is.bvarflat <- function(x) { inherits(x, "bvarflat") } #' @rdname bvhar_minnesota +#' @param x Any object #' @export is.bvharmn <- function(x) { inherits(x, "bvharmn") @@ -160,96 +163,112 @@ is.bvharmod <- function(x) { } #' @rdname predict +#' @param x Any object #' @export is.predbvhar <- function(x) { inherits(x, "predbvhar") } #' @rdname forecast_roll +#' @param x Any object #' @export is.bvharcv <- function(x) { inherits(x, "bvharcv") } #' @rdname irf +#' @param x Any object #' @export is.bvharirf <- function(x) { inherits(x, "bvharirf") } #' @rdname set_bvar +#' @param x Any object #' @export is.bvharspec <- function(x) { inherits(x, "bvharspec") } #' @rdname set_lambda +#' @param x Any object #' @export is.bvharpriorspec <- function(x) { inherits(x, "bvharpriorspec") } #' @rdname choose_bvar +#' @param x Any object #' @export is.bvharemp <- function(x) { inherits(x, "bvharemp") } #' @rdname bound_bvhar +#' @param x Any object #' @export is.boundbvharemp <- function(x) { inherits(x, "boundbvharemp") } #' @rdname set_intercept +#' @param x Any object #' @export is.interceptspec <- function(x) { inherits(x, "interceptspec") } #' @rdname set_ssvs +#' @param x Any object #' @export is.ssvsinput <- function(x) { inherits(x, "ssvsinput") } #' @rdname set_horseshoe +#' @param x Any object #' @export is.horseshoespec <- function(x) { inherits(x, "horseshoespec") } #' @rdname set_ng +#' @param x Any object #' @export is.ngspec <- function(x) { inherits(x, "ngspec") } #' @rdname set_dl +#' @param x Any object #' @export is.dlspec <- function(x) { inherits(x, "dlspec") } #' @rdname set_gdp +#' @param x Any object #' @export is.gdpspec <- function(x) { inherits(x, "gdpspec") } #' @rdname set_ldlt +#' @param x Any object #' @export is.covspec <- function(x) { inherits(x, "covspec") } #' @rdname set_ldlt +#' @param x Any object #' @export is.svspec <- function(x) { inherits(x, "svspec") } #' @rdname set_ldlt +#' @param x Any object #' @export is.ldltspec <- function(x) { inherits(x, "ldltspec") diff --git a/_pkgdown.yml b/_pkgdown.yml index fb4236cc..cf0a74c7 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -51,6 +51,7 @@ reference: - set_horseshoe - set_ng - set_dl + - set_gdp - set_ldlt - set_sv - set_intercept diff --git a/man/bound_bvhar.Rd b/man/bound_bvhar.Rd index b2c64cc7..fa631318 100644 --- a/man/bound_bvhar.Rd +++ b/man/bound_bvhar.Rd @@ -26,7 +26,7 @@ is.boundbvharemp(x) \item{upper_spec}{Upper bound Bayes model specification} -\item{x}{\code{boundbvharemp} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/bvar_flat.Rd b/man/bvar_flat.Rd index ff309128..00bd0450 100644 --- a/man/bvar_flat.Rd +++ b/man/bvar_flat.Rd @@ -57,7 +57,7 @@ is.bvarflat(x) \item{num_thread}{Number of threads} -\item{x}{\code{bvarflat} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/bvar_minnesota.Rd b/man/bvar_minnesota.Rd index 778c65cf..8ad8d3ca 100644 --- a/man/bvar_minnesota.Rd +++ b/man/bvar_minnesota.Rd @@ -69,7 +69,7 @@ is.bvarmn(x) \item{num_thread}{Number of threads} -\item{x}{\code{bvarhm} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/bvhar_minnesota.Rd b/man/bvhar_minnesota.Rd index 01948fa2..fd2e27fe 100644 --- a/man/bvhar_minnesota.Rd +++ b/man/bvhar_minnesota.Rd @@ -69,7 +69,7 @@ is.bvharmn(x) \item{num_thread}{Number of threads} -\item{x}{\code{bvharhm} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/choose_bvar.Rd b/man/choose_bvar.Rd index aee0442b..ffb8694c 100644 --- a/man/choose_bvar.Rd +++ b/man/choose_bvar.Rd @@ -59,7 +59,7 @@ is.bvharemp(x) \item{har}{Numeric vector for weekly and monthly order. By default, \code{c(5, 22)}.} -\item{x}{\code{bvharemp} object} +\item{x}{Any object} \item{digits}{digit option to print} } diff --git a/man/forecast_roll.Rd b/man/forecast_roll.Rd index 2dcdee8f..d51f175c 100644 --- a/man/forecast_roll.Rd +++ b/man/forecast_roll.Rd @@ -64,7 +64,7 @@ is.bvharcv(x) \item{...}{not used} -\item{x}{\code{bvharcv} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/irf.Rd b/man/irf.Rd index b5622ad8..d104ebd2 100644 --- a/man/irf.Rd +++ b/man/irf.Rd @@ -34,7 +34,7 @@ is.bvharirf(x) \item{...}{not used} -\item{x}{\code{bvharirf} object} +\item{x}{Any object} \item{digits}{digit option to print} } diff --git a/man/predict.Rd b/man/predict.Rd index 06ab3957..3363b7a1 100644 --- a/man/predict.Rd +++ b/man/predict.Rd @@ -106,7 +106,7 @@ Give CI level (e.g. \code{.05}) instead of \code{TRUE} to use credible interval \item{use_sv}{Use SV term} -\item{x}{\code{predbvhar} object} +\item{x}{Any object} \item{digits}{digit option to print} } diff --git a/man/set_bvar.Rd b/man/set_bvar.Rd index 1244ae3d..cde90401 100644 --- a/man/set_bvar.Rd +++ b/man/set_bvar.Rd @@ -41,7 +41,7 @@ is.bvharspec(x) \item{monthly}{Fill the third part in the first block (Default: 1)} -\item{x}{\code{bvharspec} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_dl.Rd b/man/set_dl.Rd index 5a0f965c..c7473e0e 100644 --- a/man/set_dl.Rd +++ b/man/set_dl.Rd @@ -19,7 +19,7 @@ is.dlspec(x) \item{rate}{Gamma rate} -\item{x}{\code{dlspec}} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_gdp.Rd b/man/set_gdp.Rd index d9a23749..095fbbdd 100644 --- a/man/set_gdp.Rd +++ b/man/set_gdp.Rd @@ -13,6 +13,8 @@ is.gdpspec(x) \item{shape_grid}{Griddy gibbs grid size for Gamma shape hyperparameter} \item{rate_grid}{Griddy gibbs grid size for Gamma rate hyperparameter} + +\item{x}{Any object} } \value{ \code{gdpspec} object diff --git a/man/set_horseshoe.Rd b/man/set_horseshoe.Rd index 5bac9baf..5afcaf28 100644 --- a/man/set_horseshoe.Rd +++ b/man/set_horseshoe.Rd @@ -22,7 +22,7 @@ is.horseshoespec(x) \item{global_sparsity}{Initial global shrinkage hyperparameter} -\item{x}{\code{horseshoespec}} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_intercept.Rd b/man/set_intercept.Rd index b733161b..a60b9e0c 100644 --- a/man/set_intercept.Rd +++ b/man/set_intercept.Rd @@ -20,7 +20,7 @@ is.interceptspec(x) \item{sd}{Normal standard deviance for constant term} -\item{x}{\code{interceptspec} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_lambda.Rd b/man/set_lambda.Rd index 3aa49984..af76b5af 100644 --- a/man/set_lambda.Rd +++ b/man/set_lambda.Rd @@ -33,7 +33,7 @@ is.bvharpriorspec(x) \item{scale}{Scale of Inverse Gamma distribution. By default, \code{(.02)^2}.} -\item{x}{\code{bvharpriorspec} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_ldlt.Rd b/man/set_ldlt.Rd index 9a683248..e60648b4 100644 --- a/man/set_ldlt.Rd +++ b/man/set_ldlt.Rd @@ -32,7 +32,7 @@ For SV (\code{\link[=set_sv]{set_sv()}}), this is for state variance.} \item{initial_prec}{Prior precision of initial state.} -\item{x}{\code{covspec}} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_ng.Rd b/man/set_ng.Rd index 95458070..8a280661 100644 --- a/man/set_ng.Rd +++ b/man/set_ng.Rd @@ -35,7 +35,7 @@ is.ngspec(x) \item{contem_global_scale}{Inverse gamma prior scale for contemporaneous coefficient global shrinkage} -\item{x}{\code{ngspec}} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/set_ssvs.Rd b/man/set_ssvs.Rd index 3b9e3662..e2e96a1d 100644 --- a/man/set_ssvs.Rd +++ b/man/set_ssvs.Rd @@ -53,7 +53,7 @@ is.ssvsinput(x) \item{chol_s2}{Second shape of cholesky factor prior beta distribution} -\item{x}{\code{ssvsinput}} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/var_lm.Rd b/man/var_lm.Rd index 821ba2fb..bba314eb 100644 --- a/man/var_lm.Rd +++ b/man/var_lm.Rd @@ -38,7 +38,7 @@ is.bvharmod(x) \item{method}{Method to solve linear equation system. (\code{nor}: normal equation (default), \code{chol}: Cholesky, and \code{qr}: HouseholderQR)} -\item{x}{A \code{varlse} object} +\item{x}{Any object} \item{digits}{digit option to print} diff --git a/man/vhar_lm.Rd b/man/vhar_lm.Rd index 88f7539d..2098cffd 100644 --- a/man/vhar_lm.Rd +++ b/man/vhar_lm.Rd @@ -40,7 +40,7 @@ is.vharlse(x) \item{method}{Method to solve linear equation system. (\code{nor}: normal equation (default), \code{chol}: Cholesky, and \code{qr}: HouseholderQR)} -\item{x}{A \code{vharlse} object} +\item{x}{Any object} \item{digits}{digit option to print}