Package 'iperform'

Title: Time Series Performance
Description: A tool to calculate the performance of a time series in a specific date or period. It is more intended for data analysis in the fields of finance, banking, telecommunications or operational marketing.
Authors: Patrick Ilunga [aut, cre], Ilunga Buabua Patrick [cph]
Maintainer: Patrick Ilunga <[email protected]>
License: GPL-3
Version: 0.0.3
Built: 2024-12-11 06:48:21 UTC
Source: CRAN

Help Index


Calcul de la valeur dday d'une serie.

Description

Cette fonction permet de trouver la valeur d'une série à une date voulue par l'utilisateur, le dday.

Usage

dday(data, date, d = 0, x, unite = 1, decimal = 0)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date que l'on souhaite connaitre la valeur de la serie.

d

Une valeur de type entier qui permet de décaler le jour par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(222, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2023-01-01"), by = "day", len = 222)
df <- data.frame(date, x)
dday(df, date = "2023-07-06", x = "x")

Estimation du total d'un mois sur base des quelques jours observés.

Description

Cette fonction permet estimer le total d'un mois sur base de MTD et de nombre de jour restant au courant de ce mois.

Usage

forecast_m(data, date, x, unite = 1, decimal = 0, cumul = FALSE, mod = "NULL")

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date à partir de laquelle on calcule la performance MTD.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

mod

Un argument qui permet de modifier le mode de calcul de ce forecast en appliquant un model. Sa valeur par defaut est NULL. Pour cette première version, on ne va pas travailler sur le cas où mod n'est pas NULL.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
forecast_m(df, date = "2023-01-25", x = "x")

Calcul de la performance d'un semestre : full.

Description

Cette fonction permet de calculer la somme des valeurs d'une série temporelle au cours d'un semestre par rapport à la date introduit par l'utilisateur.

Usage

full_h(data, date, h = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date à partir de laquelle on determine l’année à calculer.

h

Une valeur de type entier qui permet de décaler le semestre par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène observé.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage de résultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
full_h(df, date = "2023-01-08", x = "x")

Calcul de la performance d'un mois : full.

Description

Cette fonction permet de calculer la somme des valeurs d'une série dans le mois par rapport au mois correspondant à la date introduit par l'utilisateur.

Usage

full_m(data, date, m = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date à partir de laquelle on determine le mois à calculer.

m

Une valeur de type entier qui permet de décaler le mois par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage de résultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
full_m(df, date = "2023-01-08", x = "x")

Calcul de la performance d'une trimestre : full.

Description

Cette fonction permet de calculer la somme des valeurs d'une série temporelle au cours d'un trimestre par rapport à la date introduit par l'utilisateur.

Usage

full_q(data, date, q = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date à partir de laquelle on determine l’année à calculer.

q

Une valeur de type entier qui permet de décaler le trimestre par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène observé.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage de résultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
full_q(df, date = "2023-01-08", x = "x")

Calcul de la performance d'une semaine : full.

Description

Cette fonction permet de calculer la somme des valeurs d'une série temporelle au cours d'une semaine par rapport à la date introduit par l'utilisateur.

Usage

full_w(data, date, w = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date à partir de laquelle on determine la semaine à calculer.

w

Une valeur de type entier qui permet de décaler la semaine par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène observé.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage de résultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
full_w(df, date = "2023-01-08", x = "x")

Calcul de la performance d'une année : full.

Description

Cette fonction permet de calculer la somme des valeurs d'une série temporelle au cours d'une année par rapport à la date introduit par l'utilisateur.

Usage

full_y(data, date, a = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date à partir de laquelle on determine l’année à calculer.

a

Une valeur de type entier qui permet de décaler l’année par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène observé.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage de résultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
full_y(df, date = "2023-01-08", x = "x")

Calcul de la valeur htd d'une serie.

Description

Cette fonction permet de calculer la somme des valeurs d'une série sur un semestre depuis le 1er jour jusqu’à date introduit par l'utilisateur.

Usage

htd(data, date, h = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date que l'on souhaite connaitre la valeur de la serie.

h

Une valeur de type entier qui permet de décaler le semestre par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(222, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2023-01-01"), by = "day", len = 222)
df <- data.frame(date, x)
htd(df, date = "2023-07-06", x = "x")

Calcul de la moyenne mobile sur 7 jour.

Description

Cette fonction permet de transformer une série par une nouvelle série dont chaque terme vaut la moyenne de 6 dernier y compris le terme lui même. Cette fonction sera améliorer dans les versions à venir.

Usage

mean_m(data, x, unite = 1, decimal = 0, borne = TRUE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Une valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

borne

Une valeur de type logic permettant de preciser si les valeurs renvoyées doivent avoir le minimum et le maximum pour chauqe date. Sa valeur par defaut est TRUE.

Value

Un Data.frame content n + 3 colonnes, dont n vaut le nombre disctinct des années que contient la variable date.

Examples

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)
mean_m(df, x = "x")

Calcul de la performance mtd : month-to-date.

Description

Cette fonction permet de calculer la somme des valeurs d'une série dans le mois, partant du 1er jour du mois jusqu'à une date du même mois introduit par l'utilisateur.

Usage

mtd(data, date, m = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date jusqu'à laquelle on compte sommer les valeurs au cours du mois.

m

Une valeur de type entier qui permet de décaler le mois par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

# Voir plus d'exemples et d'explication dans la vignette("iperform")

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)
mtd(df, date = "2023-08-04", x = "x")

operateur_mobile

Description

KPI Operateur Mobile.

Usage

operateur_mobile

Format

A data frame with 990 rows and 6 variables:

date

Date, renseigne le mois où l’activité est observée

Parc

integer, renseigne le nombre des clients actifs sur une periode de 90 jours

Usage

numeric, renseigne l'usage consommé par l'ensemble des clients au cours du mois (La voix en minute et l'internet en megabyte)

Revenu

numeric, renseigne le revenu généré par l'ensemble des clients après usage d'un service

Service

character, renseigne le service mobile concerné (Voix, SMS, Internet)

Operateur

character, renseigne l'operateur de téléphonie mobile concerné

Source

Source


Calcul de l’aperçu global : overview.

Description

Cette fonction permet de donner un résumé sur les performances d'une série par rapport à une date introduit par l'utilisateur.

Usage

overview(
  data,
  date,
  x,
  unite = 1,
  decimal = 0,
  cumul = FALSE,
  freq = "jour",
  facteur
)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date jusqu’à laquelle on vq sommer les valeur de la série depuis le début de l'année.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

freq

Un objet de type character qui permet d'indiquer si la vue globale est faite sur une frequence journalière ou mensuelle. Sa valeur par defaut est jour.

facteur

Un objet de type factor ou charcter qui permet d'indiquer si le vecteur x contient des valeurs répétées.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(600, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-01-01"), by = "day", length.out = 600)
df <- data.frame(date, x)
overview(df, date = "2023-05-30", x = "x")
overview(df, date = "2023-04-25", x = "x", decimal = 2)

Calcul de la valeur qtd d'une serie.

Description

Cette fonction permet de calculer la somme des valeurs d'une série sur un trimestre depuis le 1er jour jusqu’à date introduit par l'utilisateur.

Usage

qtd(data, date, q = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date que l'on souhaite connaitre la valeur de la serie.

q

Une valeur de type entier qui permet de décaler le trimestre par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(222, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2023-01-01"), by = "day", len = 222)
df <- data.frame(date, x)
qtd(df, date = "2023-07-06", x = "x")

service_mobile

Description

KPI Service Mobile.

Usage

service_mobile

Format

A data frame with 504 rows and 5 variables:

date

Date, renseigne le mois où l’activité est observée

Parc

integer, renseigne le nombre des clients actifs sur une periode de 90 jours

Usage

numeric, renseigne l'usage consommé par l'ensemble des clients au cours du mois (La voix en minute, le SMS en nombre et l'internet en megabyte)

Revenu

integer, renseigne le revenu généré par l'ensemble des clients après usage d'un service

Service

character, renseigne le service mobile concerné (Voix, SMS, Internet)

Source

Source


Calcul de taux de variation entre les observations d'une serie.

Description

Cette fonction permet de calculer le taux de variation entre les valeurs d'une série à une date ou une periode.

Usage

taux_v(data, date, x, variation = "dtd", p = -7, normaliz = FALSE, decimal = 2)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date de l'observation d’arrivée.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

variation

Un objet de type character, definissant le type de variation à calculer. Sa valeur par defaut est dtd.

p

Une valeur de type entier qui permet de décaler le jour pour une variation journalière. Sa valeur par defaut est -7.

normaliz

Un objet de type logic, permettant de preciser si la variation doit se faire à base egale pour des périodes. Sa valeur par defaut est FALSE.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 2.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(222, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2023-01-01"), by = "day", len = 222)
df <- data.frame(date, x)
taux_v(df, date = "2023-04-30", x = "x")

voix_mobile

Description

KPI Service Voix Mobile.

Usage

voix_mobile

Format

A data frame with 1003 rows and 4 variables:

date

Date

Parc

de type integer, le nombre de clients ayant utiliser le service voix dans le 30 jour

Usage

de type numeric, le nombre de minutes consommées par l'ensemble des clients

Revenu

de type numeric, le revenu genéré par l'ensemble des clients après usage (sous un quelque tarif du service)

Source

Source


Calcul de la performance wtd : week-to-date.

Description

Cette fonction permet de calculer la somme des valeurs d'une série dans la semaine, partant du 1er jour de la semaine jusqu'à la date introduit par l'utilisateur. Pour cette première version, on garde par defaut dimanche comme premier jour de la semaine.

Usage

wtd(data, date, w = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date que l'on souhaite connaitre la valeur de la serie.

w

Une valeur de type entier qui permet de décaler la semaine par rapport à la date introduite. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

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)
wtd(df, date = "2023-08-01", x = "x")

Calcul de la performance ytd : year-to-date.

Description

Cette fonction permet de calculer la somme des valeurs d'une série dans l'année, partant du 1er jour de l'année jusqu'à une date de la même année introduit par l'utilisateur.

Usage

ytd(data, date, a = 0, x, unite = 1, decimal = 0, cumul = FALSE)

Arguments

data

Un objet de type data.frame contenant au minimum la serie numerique et un vecteur de type date.

date

La date jusqu’à laquelle on vq sommer les valeur de la série depuis le début de l'année.

a

Une valeur de type entier qui permet de décaler l'année par rapport à la date introduite si la série s'etend sur plus d'une année. Sa valeur par defaut est 0.

x

Un vecteur de type numeric contenant les observations du phénomène à etudier.

unite

Un valeur de type numeric, definissant l'ordre d'echelle d'affisage du resultat de la fonction. Sa valeur par defaut est 1.

decimal

Un objet de type numeric permettant de préciser le nombre d'entier à afficher après la virgule. Sa valeur par defaut est 0.

cumul

Un objet de type logic qui permet d'indiquer si le vecteur x contient des valeurs cumulées. Sa valeur par defaut est FALSE.

Value

Un vecteur de longieur 1.

Examples

x <- rnorm(102, mean = 50, sd = 6.3)
date <- seq.Date(as.Date("2022-12-01"), by = "day", length.out = 102)
df <- data.frame(date, x)
ytd(df, date = "2023-01-08", x = "x")