iperform

Introduction

Le but de iperform est de permettre aux utilisateurs de calculer les performances d’une série temporelle à une date ou une période donnée. On peut citer par exemple la performance month-to-date : MTD (respectivement year-to-date : YTD) qui consiste à la somme des valeurs de la série partant du premier jour du mois (respectivement premier jour de l’année civil) jusqu’à date. Le package permet également de présenter un aperçu global d’une série temporelle différemment de ce qu’on a par exemple avec la fonction summary().

Apprenez-en plus sur les fonctions de iperform dans vignette("iperform").

Installation

L’installation est très simple, depuis CRAN :

install.packages("iperform", dependencies = TRUE)

On peut installer le package depuis ce repository GitHub :

if(!require(devtools)) {
  install.packages("devtools")
  }
devtools::install_github("ipatriqIP/package_iperform")

Example

Voici un exmple simple sur l’utilisation de la fonction mtd() si l’on veut calculer la performance month-to-date en date du 04 août 2023 :

# importation du package
library(iperform)

## définition des données 
x <- rnorm(222, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2023-01-01"), by = "day", length.out = 222)
df <- data.frame(date, x)

# appel de la fonction mtd()
mtd(df, date = "2023-08-04", x = "x", decimal = 2)
#> [1] 208.39

Pour verifier, on peut afficher les valeurs qui ont été sommées et verifier le calcul à la main :

# mont-to-date au 4 août 2023 signifie les valeurs du 1er août au 4 août iclus
df[(df[, "date"] >= "2023-08-01") & (df[, "date"] <= "2023-08-04"), "x"]
#> [1] 49.22324 54.96808 48.55842 55.64443

# La somme de ces valeurs
round(sum(df[(df[, "date"] >= "2023-08-01") & (df[, "date"] <= "2023-08-04"), "x"]), 2)
#> [1] 208.39

Catégorie des fonctions

Les fonctions de iperform se regroupent en 4 catégories :

• “Les performances” qui renvoient les valeurs de la série en une date ou une la somme sur une période donnée. On cite les fonctions dday(), wtd(), mtd(), qtd(), htd(), ytd(), full_w(), full_m(), full_q(), full_h() et full_y().

• “Les aperçus” qui renvoient des résumés sur la série en combinant les variations comparées aux périodes antérieures de la série. On cite les fonctions taux_v() et overview().

• “Les previsions” qui renvoient les estimations de valeurs de la série en des dates futures. On cite la fonction forecast_m().

• “Les transformations” qui renvoient des nouveaux jeu des données créés après transformation de la série intiales. On cite la fonction mean_m().

Obtenir de l’aide

Dans le cas où vous rencontrez un bug évident, veuillez déposer un exemple minimal reproductible sur github. Pour toute question et autre discussion, veuillez utiliser community.rstudio.com.