Skip to content

Commit

Permalink
Docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchelloharawild committed Sep 17, 2024
1 parent c8cf058 commit 536dda2
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 147 deletions.
4 changes: 1 addition & 3 deletions R/var.R
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ specials_var <- new_specials(
#'
#' @section Specials:
#'
#' \subsection{pdq}{
#' \subsection{AR}{
#' The `AR` special is used to specify the lag order for the auto-regression.
#' \preformatted{
#' AR(p = 0:5)
Expand Down Expand Up @@ -438,8 +438,6 @@ generate.VAR <- function(x, new_data, specials, ...){
#' @param impulse A character string specifying the name of the variable that is shocked (the impulse variable).
#' @param orthogonal If TRUE, orthogonalised impulse responses will be computed.
#'
#' @seealso [`fabletools::IRF.mdl_df`]
#'
#' @export
IRF.VAR <- function(x, new_data, specials, impulse = NULL, orthogonal = FALSE, ...) {
# Zero out end of data
Expand Down
6 changes: 2 additions & 4 deletions R/vecm.R
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ specials_vecm <- new_specials(
#'
#' @section Specials:
#'
#' \subsection{pdq}{
#' \subsection{AR}{
#' The `AR` special is used to specify the lag order for the auto-regression.
#' \preformatted{
#' AR(p = 0:5)
Expand All @@ -189,7 +189,7 @@ specials_vecm <- new_specials(
#' }
#'
#' \subsection{xreg}{
#' Exogenous regressors can be included in an VAR model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()].
#' Exogenous regressors can be included in an VECM model without explicitly using the `xreg()` special. Common exogenous regressor specials as specified in [`common_xregs`] can also be used. These regressors are handled using [stats::model.frame()], and so interactions and other functionality behaves similarly to [stats::lm()].
#'
#' The inclusion of a constant in the model follows the similar rules to [`stats::lm()`], where including `1` will add a constant and `0` or `-1` will remove the constant. If left out, the inclusion of a constant will be determined by minimising `ic`.
#'
Expand Down Expand Up @@ -415,8 +415,6 @@ generate.VECM <- function(x, new_data, specials, ...){
#' @param impulse A character string specifying the name of the variable that is shocked (the impulse variable).
#' @param orthogonal If TRUE, orthogonalised impulse responses will be computed.
#'
#' @seealso [`fabletools::IRF.mdl_df`]
#'
#' @export
IRF.VECM <- function(x, new_data, specials, impulse = NULL, orthogonal = FALSE, ...) {
# Zero out end of data
Expand Down
8 changes: 3 additions & 5 deletions man/VECM.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 0 additions & 27 deletions man/fitted.VECM.Rd

This file was deleted.

42 changes: 0 additions & 42 deletions man/forecast.VECM.Rd

This file was deleted.

17 changes: 5 additions & 12 deletions man/glance.VECM.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 0 additions & 27 deletions man/residuals.VECM.Rd

This file was deleted.

27 changes: 0 additions & 27 deletions man/tidy.VECM.Rd

This file was deleted.

0 comments on commit 536dda2

Please sign in to comment.