evalhyd.vigicrues.plot_rank_hist

plot_rank_hist(rank_hist, row=None, col=None, figsize=None, savefig_kwargs=None, output_dir='.')

Générer des diagrammes de rangs à partir des données de sortie de la fonction evalhyd.vigicrues.evalp.

Note

Pour des données multi-entités et/ou multi-échéances et/ou multi-sous-ensembles, une figure par entité, par échéance et par sous-ensemble est générée par défaut. Les paramètres row et col peuvent être utilisés pour afficher toutes les entités et/ou toutes les échéances et/ou tous les sous-ensembles sur une même figure.

Note

Les noms de fichiers sont standardisés et détaillent leur contenu. Ainsi, les noms contiennent les entités suivies des échéances suivies des sous-ensembles. Si les paramètres row et/ou col sont utilisés, les noms de fichiers sont modifiés en conséquence et contiennent toutes-entités et/ou toutes-échéances et/ou tous-sous-ensembles selon les cas.

Warning

Les données de sortie comportant un échantillonnage par bootstrap ne sont pas supportées par cette fonction.

Paramètres:

rank_hist: pandas.DataFrame: La dataframe produite par evalhyd.vigicrues.evalp correspondant à l’indicateur RANK_HIST.
row: str, optionnel: À utiliser pour produire des figures contenant plusieurs diagrammes de rangs côte-à-côte. La dimension fournie via ce paramètre sera utilisée pour former une ligne de diagrammes de rangs. Utilisé en combinaison avec le paramètre col produira une matrice 2D de diagrammes de rangs.
col: str, optionnel: À utiliser pour produire des figures contenant plusieurs diagrammes de rangs côte-à-côte. La dimension fournie via ce paramètre sera utilisée pour former une colonne de diagrammes de rangs. Utilisé en combinaison avec le paramètre row produira une matrice 2D de diagrammes de rangs.
figsize: tuple, optionnel: La largeur et la hauteur en pouces des figures produites.
savefig_kwargs: str, optionnel: Les arguments à passer à matplotlib.figure.Figure.savefig pour personnaliser les figures produites. Parmi les paramètres possibles, ceux définis par cette fonction pour défaut sont format='png' et dpi=300. Ils seront écrasés par ceux passés via ce paramètre le cas échéant.
output_dir: str, optionnel: Le chemin absolu ou relatif vers le répertoire où les images seront sauvegardées. Si ce paramètre n’est pas fourni, le répertoire de travail courant est utilisé.

Retourne:

List[str]: L’ensemble des chemins des fichiers produits par la fonction.