Analysis

Dans ce module, la fonction get_dataset récupère un jeu de données (simulé). La classe Results offre quelques fonctions pour résumer et fusionner les données et pour évaluer la préparation pour la retraite.

CPR.analysis.get_dataset()

Fonction qui renvoie un dataframe de données synthétiques.

Renvoie

Dataframe de données synthétiques.

Type renvoyé

pandas.core.frame.DataFrame

class CPR.analysis.Results(input_data, output, common, prices, extra_params)

Cette classe prépare les résultats.

Paramètres

• input_data (pandas.core.frame.DataFrame) – dataframe d’intrants

• output (pandas.core.frame.DataFrame) – dataframe d’extrants

• common (Common) – instance de la classe Common

• prices (Prices) – instance de la classe Prices

• extra_params (dict) – dictionnaire de paramètres supplémentaires

summarize()

Fonction pour résumer la simulation.

merge(add_index=True)

Fonction pour fusionner les variables d’entrée et de sortie pour créer une base de données.

Paramètres

add_index (bool, optional) – ajouter l’indice à la base de données, True (Vrai) par défaut

check_preparedness(factor_couple=2, cons_floor=100, d_cutoffs={20: 80, 100: 65})

Fonction qui introduit un plancher de consommation, calcule l’IPR (NaN si la consommation avant et après la retraite sont en deçà de cons_floor), et vérifie la préparation pour la retraite.

Paramètres

• factor_couple (int, optional) – facteur de normalisation du revenu pour les couples, par défaut 2

• cons_floor (int, optional) – plancher de consommation, par défaut 100

• d_cutoffs (dict, optional) – seuils, par défaut {20: 80, 100: 65}