Skip to content

Commit

Permalink
Merge pull request #29 from AQLT/develop
Browse files Browse the repository at this point in the history
Doc correction
  • Loading branch information
AQLT authored May 23, 2024
2 parents f5dd0d5 + e9fc40a commit 7b2373f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Authors@R: c(
person("Alain", "Quartier-la-Tente", role = c("aut","cre"),
email = "[email protected]",
comment = c(ORCID = "0000-0001-7890-3857")),
person("Tanguy", "Barthelemy", role = c("aut"),
person("Tanguy", "Barthelemy", role = c("ctb"),
email ="[email protected]"),
person("Anna", "Smyk", role = c("aut"),
person("Anna", "Smyk", role = c("ctb"),
email ="[email protected]")
)
Description: This package provides functions to build and apply symmetric
Expand Down
6 changes: 5 additions & 1 deletion R/2_finite_filters.R
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,11 @@ to_seasonal.finite_filters <- function(x, s){
#' @details
#' When combining finite filters and a moving average, the first and/or the last points cannot be computed.
#'
#' For example, using the M2X12 moving average (symmetric moving average with coefficients \eqn{\theta = \begin{pmatrix} 1/24 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/12 & 1/24 \end{pmatrix}}), the first and last 6 points cannot be computed.
#' For example, using the M2X12 moving average, that is to say the symmetric moving average with coefficients
#' \deqn{
#' \theta = \frac{1}{24}B^{6} + \frac{1}{12}B^{5}+\dots+\frac{1}{12}B^{-5}+\frac{1}{24}B^{-6},
#' }
#' the first and last 6 points cannot be computed.
#'
#' `impute_last_obs()` allows to impute the first/last points using the `nperiod` previous filtered data. With `nperiod = 1`, the last filtered data is used for the imputation, with `nperiod = 12` and monthly data, the last year filtered data is used for the imputation, etc.
#'
Expand Down
6 changes: 5 additions & 1 deletion man/impute_last_obs.Rd

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

0 comments on commit 7b2373f

Please sign in to comment.