revise package structure: always predict from 1am to horizon, dataset not cut at...

[talweg.git] / reports / PackageR.gj

diff --git a/reports/PackageR.gj b/reports/PackageR.gj
index d62dc36..567bfd6 100644 (file)
--- a/reports/PackageR.gj
+++ b/reports/PackageR.gj
@@ -25,18 +25,17 @@ ts_data <- read.csv(system.file("extdata","pm10_mesures_H_loc.csv",
        package="talweg"))
 exo_data <- read.csv(system.file("extdata","meteo_extra_noNAs.csv",
        package="talweg"))
-data <- getData(ts_data, exo_data, input_tz="GMT",
-       date_format="%d/%m/%Y %H:%M", working_tz="GMT",
-       predict_at=7, limit=120)
+data <- getData(ts_data, exo_data,
+       date_format="%d/%m/%Y %H:%M", limit=120)
 # Plus de détails à la section 1 ci-après.
 
 # Prédiction de 10 courbes (jours 102 à 111)
-pred <- computeForecast(data, 101:110, "Persistence", "Zero", memory=50,
-       horizon=12, ncores=1)
+pred <- computeForecast(data, 101:110, "Persistence", "Zero",
+       predict_from=8, memory=50, horizon=24, ncores=1)
 # Plus de détails à la section 2 ci-après.
 
 # Calcul des erreurs (sur un horizon arbitraire <= horizon de prédiction)
-err <- computeError(data, pred, horizon=6)
+err <- computeError(data, pred, predict_from=8, horizon=20)
 # Plus de détails à la section 3 ci-après.
 
 # Puis voir ?plotError et les autres plot dans le paragraphe 'seealso'
@@ -51,14 +50,9 @@ première colonne contient les heures, la seconde les valeurs.
 première colonne contient les jours, les $m$ suivantes les variables mesurées pour ce
 jour, et les $m$ dernières les variables prédites pour ce même jour. Dans notre cas $m=4$
 : pression, température, gradient de température, vitesse du vent.
- 3. **input_tz** : zone horaire pour ts_data (défaut : "GMT").
- 4. **date_format** : format des heures dans ts_data (défaut : "%d/%m/%Y %H:%M", format
-du fichier transmis par Michel).
- 5. **working_tz** : zone horaire dans laquelle on souhaite travailler avec les données
-(défaut : "GMT").
- 6. **predict_at** : heure à laquelle s'effectue la prévision $-$ et donc dernière heure
-d'un bloc de 24h, relativement à working_tz. data`$`getSerie(3) renvoit ainsi les 24
-valeurs de 8h à 7h pour le $3^{eme}$ bloc de 24h présent dans le jeu de données.
+ 3. **date_format** : format des heures dans ts_data (défaut : "%d/%m/%Y %H:%M", format
+du fichier transmis par Michel Bobbia).
+ 4. **limit** : nombre de séries à récupérer.
 -----r
 print(data)
 #?Data
@@ -76,10 +70,11 @@ blocs de 24h) ; peut être donnée sous forme d'un vecteur de dates ou d'entiers
 ?computeForecast
  5. **memory** : le nombre de jours à prendre en compte dans le passé pour chaque
 prévision (par défaut : Inf, c'est-à-dire tout l'historique pris en compte).
- 6. **horizon** : le nombre d'heures à prédire ; par défaut "data`$`getStdHorizon()",
-c'est-à-dire le nombre d'heures restantes à partir de l'instant de prévision + 1 jusqu'à
-minuit (17 pour predict_at=7 par exemple).
- 7. **ncores** : le nombre de processus parallèles (utiliser 1 pour une exécution
+ 6. **predict_from** : première heure de prévision. Les séries prévues démarrent
+cependant toutes à 1h du matin (en reprenant les premières valeurs connues).
+ 7. **horizon** : dernière heure de prévision ; maximum 24 == minuit (valeur par défaut).
+pred`$`getForecast(i) retourne une journée complète de 01:00 à 00:00 si horizon=24.
+ 8. **ncores** : le nombre de processus parallèles (utiliser 1 pour une exécution
 séquentielle)
 -----r
 print(pred)
@@ -91,9 +86,10 @@ Les arguments de cette fonction sont, dans l'ordre :
 
  1. **data** : le jeu de données renvoyé par getData()
  2. **pred** : les prédictions renvoyées par computeForecast()
- 3. **horizon** : le nombre d'heures à considérer pour le calcul de l'erreur ; doit être
-inférieur ou égal à l'horizon utilisé pour la prédiction (même valeur par défaut :
-"data`$`getStdHorizon()")
+ 3. **predict_from** : première heure de prévision ; peut être différente de l'analogue
+dans l'appel à *computeForecast()*.
+ 4. **horizon** : dernière heure de prévision à considérer pour le calcul de l'erreur ;
+inférieure ou égale à la valeur de l'argument analogue dans *computeForecast()*
 -----r
 summary(err)
 summary(err$abs)