29c48226611a18bd8963511b00e73b571477af8d
[talweg.git] / reports / PackageR.gj
1 -----
2 # Package R "talweg"
3
4 Le package $-$ Time-series sAmpLes forecasted With ExoGenous variables $-$ contient le
5 code permettant de lancer les expériences numériques décrites dans le chapitre suivant.
6 Les fonctions principales sont respectivement
7
8 * **getData()** pour construire un objet R contenant les données à partir de fichiers
9 CSV (extraits de bases de données). Le format choisi en R est une classe R6 (du package
10 du même nom) exposant en particulier les méthodes *getSerie(i)* et *getExo(i)* qui
11 renvoient respectivement la $i^{eme}$ série de 24h et les variables exogènes (mesurées)
12 correspondantes. Voir ?Data pour plus d'information, une fois le package chargé.
13 * **computeForecast()** pour calculer des prédictions sur une certaine plage temporelle
14 contenue dans *data <- getData(...)*
15 * **computeError()** pour évaluer les erreurs commises par différentes méthodes.
16
17 Le package contient en outre diverses fonctions graphiques *plotXXX()*, utilisées dans la
18 partie suivante.
19 -----r
20 # Chargement de la librairie (après compilation, "R CMD INSTALL .")
21 library(talweg)
22
23 # Acquisition des données (depuis les fichiers CSV)
24 ts_data <- read.csv(system.file("extdata","pm10_mesures_H_loc.csv", package="talweg"))
25 exo_data <- read.csv(system.file("extdata","meteo_extra_noNAs.csv", package="talweg"))
26 data <- getData(ts_data, exo_data, date_format="%d/%m/%Y %H:%M", limit=120)
27 # Plus de détails à la section 1 ci-après.
28
29 # Prédiction de 10 courbes (jours 102 à 111)
30 pred <- computeForecast(data, 101:110, "Persistence", "Zero", predict_from=8, memory=50,
31 horizon=24, ncores=1)
32 # Plus de détails à la section 2 ci-après.
33
34 # Calcul des erreurs (sur un horizon arbitraire <= horizon de prédiction)
35 err <- computeError(data, pred, predict_from=8, horizon=20)
36 # Plus de détails à la section 3 ci-après.
37
38 # Puis voir ?plotError et les autres plot dans le paragraphe 'seealso'
39 -----
40 ${"##"} getData()
41
42 Les arguments de cette fonction sont, dans l'ordre :
43
44 1. **ts_data** : séries temporelles (fichier CSV avec entête ou data.frame) ; la
45 première colonne contient les heures, la seconde les valeurs.
46 2. **exo_data** : variables exogènes (fichier CSV avec entête ou data.frame) ; la
47 première colonne contient les jours, les $m$ suivantes les variables mesurées pour ce
48 jour, et les $m$ dernières les variables prédites pour ce même jour. Dans notre cas $m=4$
49 : pression, température, gradient de température, vitesse du vent.
50 3. **date_format** : format des heures dans ts_data (défaut : "%d/%m/%Y %H:%M", format
51 du fichier transmis par Michel Bobbia).
52 4. **limit** : nombre de séries à récupérer.
53 -----r
54 print(data)
55 #?Data
56 -----
57 ${"##"} computeForecast()
58
59 Les arguments de cette fonction sont, dans l'ordre :
60
61 1. **data** : le jeu de données renvoyé par getData()
62 2. **indices** : l'ensemble de jours dont on veut prévoir les "lendemains" (prochains
63 blocs de 24h) ; peut être donnée sous forme d'un vecteur de dates ou d'entiers
64 (correspondants aux numéros des jours).
65 3. **forecaster** : le nom du prédicteur principal à utiliser ; voir ?computeForecast
66 4. **pjump** : le nom du prédicteur de saut d'une série à l'autre ; voir
67 ?computeForecast
68 5. **memory** : le nombre de jours à prendre en compte dans le passé pour chaque
69 prévision (par défaut : Inf, c'est-à-dire tout l'historique pris en compte).
70 6. **predict_from** : première heure de prévision. Les séries prévues démarrent
71 cependant toutes à 1h du matin (en reprenant les premières valeurs connues).
72 7. **horizon** : dernière heure de prévision ; maximum 24 == minuit (valeur par défaut).
73 pred`$`getForecast(i) retourne une journée complète de 01:00 à 00:00 si horizon=24.
74 8. **ncores** : le nombre de processus parallèles (utiliser 1 pour une exécution
75 séquentielle)
76 -----r
77 print(pred)
78 #?computeForecast
79 -----
80 ${"##"} computeError()
81
82 Les arguments de cette fonction sont, dans l'ordre :
83
84 1. **data** : le jeu de données renvoyé par getData()
85 2. **pred** : les prédictions renvoyées par computeForecast()
86 3. **predict_from** : première heure de prévision ; peut être différente de l'analogue
87 dans l'appel à *computeForecast()*.
88 4. **horizon** : dernière heure de prévision à considérer pour le calcul de l'erreur ;
89 inférieure ou égale à la valeur de l'argument analogue dans *computeForecast()*
90 -----r
91 summary(err)
92 summary(err$abs)
93 summary(err$MAPE)
94 -----
95 ${"##"} Graphiques
96
97 Voir ?plotError : les autres fonctions graphiques sont dans la section 'seealso' :
98
99 ‘plotCurves’, ‘plotPredReal’, ‘plotSimils’, ‘plotFbox’,
100 ‘computeFilaments’, ‘plotFilamentsBox’, ‘plotRelVar’
101
102 ?plotXXX, etc.