Skip to contents

Données d'entrée

Frédéric Grelot

data-input.Rmd

Introduction

Les données d’entrée d’un cas d’étude sont stockées dans 4 data.frame,qui doivent être stockés dans des éléments une liste pour être utilisées par analyse_uncertainty(). Les noms attendus des éléments de la liste sont fixes et doivent correspondre à :

  • calendar
  • cost.
  • flood
  • impact

Pour créer ces données, le plus simple est de les lire depuis des fichiers externes en mobilisant la fonction load_data().

Fichiers externes attendus par load_data()

load_data() peut importer différents formats de données. La fonction a besoin de connaître l’emplacement de ces données sur le poste de travail. Cet emplacement est caractérisé à partir de deux paramètres :

  • path_input, le chemin du dossier dans lequel se trouve le cas d’étude ;
  • case, le nom du dossier correspondant au cas d’étude.

load_data() a également besoin de connaître :

  • path_output, le chemin du dossier dans lequel seront sauvegardées les différentes sorties. Ces sorties seront pour leur très grande majorité stockées dans un dossier qui aura comme nom case. La seul exception sera l’éventuel fichier compressé des sorties qui pourra être demandé au cours des analyses.

Format csv

Si load_data est utilisée avec la paramètre type_input fixé à csv2 (valeur par défaut) ou à csv1, il sera nécessaire de stocker dans le dossier case 4 fichiers correspondant aux 4 éléments de la liste précédemment citée.

Ces 4 fichiers devront avoir pour nom :

  • calendar.csv
  • cost.csv
  • flood.csv
  • impact.csv

Il est possible d’utiliser comme opérateur décimal :

  • , avec l’option type_input fixé à csv2 ;
  • . avec l’option type_input fixé à csv1 
path_input = system.file("extdata", package = "floodam.cba.sa")
case = "test"
input_csv = load_data(case, path_input)
#> Case 'test' successfully loaded.
#> Key informations are:
#>  - 'floodam.cba.sa' in version 1.0.1.0 is used with:
#>      - n=1000
#>      - rate=constant
#>  - 'sensitivity' in version 1.30.1 is used.
#>  - input are taken from '/tmp/RtmpXW9CLS/temp_libpathf4133c3201f/floodam.cba.sa/extdata/test'
#>  - output are saved in '/tmp/RtmpzK2CEF/test'

Format ods ou xlsx

Si load_data est utilisée avec la paramètre type_input fixé à ods ou xlsx, il sera attendu dans le dossier case un fichier de type correspondant comprenant 4 onglets avec les noms suivants :

  • calendar
  • cost
  • flood
  • impact
path_input = system.file("extdata", package = "floodam.cba.sa")
case = "test"
input_ods = load_data(case, path_input, type_input = "ods")
#> Case 'test' successfully loaded.
#> Key informations are:
#>  - 'floodam.cba.sa' in version 1.0.1.0 is used with:
#>      - n=1000
#>      - rate=constant
#>  - 'sensitivity' in version 1.30.1 is used.
#>  - input are taken from '/tmp/RtmpXW9CLS/temp_libpathf4133c3201f/floodam.cba.sa/extdata/test'
#>  - output are saved in '/tmp/RtmpzK2CEF/test'
input_xlsx = load_data(case, path_input, type_input = "xlsx")
#> Case 'test' successfully loaded.
#> Key informations are:
#>  - 'floodam.cba.sa' in version 1.0.1.0 is used with:
#>      - n=1000
#>      - rate=constant
#>  - 'sensitivity' in version 1.30.1 is used.
#>  - input are taken from '/tmp/RtmpXW9CLS/temp_libpathf4133c3201f/floodam.cba.sa/extdata/test'
#>  - output are saved in '/tmp/RtmpzK2CEF/test'

Format attendu pour chaque données d’entrée

Calendrier de réalisation

Le calendrier de réalisation est stcoké dans l’élément calendar des données d’entrée. Ce data.frame a les caractéristiques suivantes :

  • Des noms de colonnes, qui correspondent aux premières lignes des fichiers d’entrée.
  • Des noms de ligne, qui correspondent à la première colonne des fichiers d’entrée. Dans les fichiers du case test, cette colonne est appelée year, mais le choix du nom n’a aucune incidence. Ces années doivent être stockées sous forme d’entier et donne l’horizon temporel pour l’évaluation.
  • Les colonnes suivantes donnent le taux de prise en compte de chacun des postes dans les flux économiques correspondant.
  • Une de ces colonnes et une seule doit s’appeler benefit. Elle donne le taux de prise en compte des bénéfices à chaque année. Les valeurs attendues sont 0 tant qu’aucun projet n’est réalisé, a minima en année 0 ; 1 lorsque l’ensemble des projets sont réalisés ; des valeurs entre 0 et 1 pendant la réalisation des projets (0 étant une valeur admissible).
  • Les autres colonnes, dont les intitulés varient d’un cas d’étude à un autre, donnent les coûts considérés sur le cas d’étude. Ces intitulés doivent correspondre exactement avec ceux de l’élément cost.
  • Pour un coût d’investissement, les valeurs attendues sont entre 0 et 1, avec une somme égale à 1, permettant de répartir les coûts données dans cost en fonction du calendrier de réalisation.
  • Pour un coût de maintenance, les valeurs attendues sont également entre 0 et 1 : 0 lorsqu’aucune maintenance n’est encore prévue, 1 lorsque la maintenance attendue est complète, une valeur intermédiaire en cas de maintenance partielle.
Le calendrier pour le cas test
benefit protection_1 protection_2 maintenance_1 maintenance_2
0 0.00 0.25 0.00 0 0
1 0.00 0.50 0.00 0 0
2 0.00 0.25 0.00 0 0
3 0.75 0.00 0.25 1 0
4 0.75 0.00 0.50 1 0
5 0.75 0.00 0.25 1 0
6 1.00 0.00 0.00 1 1
7 1.00 0.00 0.00 1 1
8 1.00 0.00 0.00 1 1
9 1.00 0.00 0.00 1 1
10 1.00 0.00 0.00 1 1
11 1.00 0.00 0.00 1 1
12 1.00 0.00 0.00 1 1
13 1.00 0.00 0.00 1 1
14 1.00 0.00 0.00 1 1
15 1.00 0.00 0.00 1 1
16 1.00 0.00 0.00 1 1
17 1.00 0.00 0.00 1 1
18 1.00 0.00 0.00 1 1
19 1.00 0.00 0.00 1 1
20 1.00 0.00 0.00 1 1
21 1.00 0.00 0.00 1 1
22 1.00 0.00 0.00 1 1
23 1.00 0.00 0.00 1 1
24 1.00 0.00 0.00 1 1
25 1.00 0.00 0.00 1 1
26 1.00 0.00 0.00 1 1
27 1.00 0.00 0.00 1 1
28 1.00 0.00 0.00 1 1
29 1.00 0.00 0.00 1 1
30 1.00 0.00 0.00 1 1
31 1.00 0.00 0.00 1 1
32 1.00 0.00 0.00 1 1
33 1.00 0.00 0.00 1 1
34 1.00 0.00 0.00 1 1
35 1.00 0.00 0.00 1 1
36 1.00 0.00 0.00 1 1
37 1.00 0.00 0.00 1 1
38 1.00 0.00 0.00 1 1
39 1.00 0.00 0.00 1 1
40 1.00 0.00 0.00 1 1
41 1.00 0.00 0.00 1 1
42 1.00 0.00 0.00 1 1
43 1.00 0.00 0.00 1 1
44 1.00 0.00 0.00 1 1
45 1.00 0.00 0.00 1 1
46 1.00 0.00 0.00 1 1
47 1.00 0.00 0.00 1 1
48 1.00 0.00 0.00 1 1
49 1.00 0.00 0.00 1 1
50 1.00 0.00 0.00 1 1

Coûts du projet

les coûts du projet sont décrits dans l’élément cost. Ce data.frame a les caractéristiques suivantes :

  • Des noms de colonnes, qui correspondent aux premières lignes des fichiers d’entrée.
  • Des noms de ligne, qui correspondent à la première colonne des fichiers d’entrée. Dans les fichiers du case test, cette colonne est appelée cost. mais le choix du nom n’a aucune incidence. Les différents postes de considérés sur le cas d’étude y sont stockés. Ces intitulés doivent correspondre exactement avec ceux de l’élément calendar.
  • La colonne intitulée nominal donne les valeurs nominales de chacun des coûts considérés.
  • La colonne intitulée min donne la borne min à considérer lors des tirages aléatoires.
  • La colonne intitulée max donne la borne max à considérer lors des tirages aléatoires.
  • La colonne intitulée type donne le type de variation à prendre en compte pour les bornes, soit absolues (absolute), soit relatives à la valeur de la colonne nominal (relative).
Les données sur les coûts pour le cas test
nominal min max type
protection_1 2.442 2.0 8.0 absolute
protection_2 1.289 -0.5 1.0 relative
maintenance_1 0.070 -0.5 0.5 relative
maintenance_2 0.040 -0.5 0.5 relative

Scénarios d’inondation

Les scénarios d’inondation sont décrits dans l’élément flood. Ce data.frame a les caractéristiques suivantes :

  • Des noms de colonnes, qui correspondent aux premières lignes des fichiers d’entrée.
  • Des noms de ligne, qui correspondent à la première colonne des fichiers d’entrée. Dans les fichiers du case test, cette colonne est appelée flood. mais le choix du nom n’a aucune incidence. Les différents intitulés des scénarios d’inondation considérés sur le cas d’étude y sont stockés. Ces intitulés doivent correspondre exactement avec ceux de l’élement impact.
  • La colonne intitulée period_nominal donne les valeurs nominales des périodes de retour de chacun des scénarios d’inondation.
  • La colonne intitulée period_min donne la borne min à considérer pour les périodes de retour lors des tirages aléatoires.
  • La colonne intitulée period_max donne la borne max à considérer pour les périodes de retour lors des tirages aléatoires.
  • La colonne intitulée period_type donne le type de variation à prendre en compte pour les bornes des périodes de retour, soit absolues (absolute), soit relatives à la valeur de la colonne nominal (relative).
  • La colonne intitulée hydraulic_nominal donne les valeurs nominales des facteurs d’ajustement hydraulique de chacun des scénarios d’inondation.
  • La colonne intitulée period_min donne la borne min à considérer pour les facteurs d’ajustement hydraulique lors des tirages aléatoires.
  • La colonne intitulée period_max donne la borne max à considérer pour les facteurs d’ajustement hydraulique lors des tirages aléatoires.
  • La colonne intitulée period_type donne le type de variation à prendre en compte pour les bornes des facteurs d’ajustement hydraulique, soit absolues (absolute), soit relatives à la valeur de la colonne nominal (relative).
Les données sur les scénarios d’inondation pour le cas test
period_nominal period_min period_max period_type hydraulic_nominal hydraulic_min hydraulic_max hydraulic_type
crue_deb 4 3 5 absolute 1 -0.5 0 relative
crue_010 10 6 15 absolute 1 -0.5 0 relative
crue_030 30 20 40 absolute 1 -0.5 0 relative
crue_100 100 75 150 absolute 1 -0.5 0 relative
crue_max 1000 150 1000 absolute 1 -0.5 0 relative

Impacts du projet

Les impacts du projet sont décrits dans l’élément impact. Ce data.frame a les caractéristiques suivantes :

  • Des noms de colonnes, qui correspondent aux premières lignes des fichiers d’entrée.
  • Des noms de ligne, qui correspondent à la première colonne des fichiers d’entrée. Dans les fichiers du case test, cette colonne est appelée stake. mais le choix du nom n’a aucune incidence. Les différents intitulés des enjeux considérés sur le cas d’étude y sont stockés.
  • Les colonnes suivantes, dont les intitulés doivent correspondre exactement avec la colonne flood du fichier flood.csv, donnent les valeurs nominales des impacts attendus au sens des dommages évités. Les valeurs positives correspondent donc à des dommages effectivement évités, les valeurs négatives à des sur-dommages.
  • La colonne intitulée min donne la borne min à considérer pour les dommages évités lors des tirages aléatoires.
  • La colonne intitulée max donne la borne max à considérer pour les dommages évités lors des tirages aléatoires.
  • La colonne intitulée type, donne le type de variation à prendre en compte pour les bornes des périodes de retour, soit absolues (absolute), soit relatives à la valeur de la colonne nominal (relative).
Les données d’impact pour le cas test
crue_deb crue_010 crue_030 crue_100 crue_max min max type
habitation 0 2.0 6.0 3.0 0 -0.5 0.5 relative
activite 0 2.0 4.0 4.0 0 -0.5 0.5 relative
agricole 0 -0.1 -0.2 -0.4 0 -0.5 0.5 relative
reseau 0 0.5 0.3 0.0 0 -0.5 0.5 relative
camping 0 0.2 0.5 -0.3 0 -0.5 0.5 relative

Remarque Pour un type d’enjeu donné, c’est-à-dire pour une ligne donnée, les bornes min et max utilisées dans ce fichier sont valables pour toutes les valeurs nominales. C’est pourquoi il est nécessaire de laisser le type à relative dans ce fichier.