Module:Population de France/Données/Documentation

Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.

Utilisation modifier

Fonctions liées au chargement et à l'exploitation des données de population d'une commune/département/région/…

Voir Discussion module:Population de France/Données pour une description du format des données.

Les fonctions sont :

p.charge_donnees(nom) : charge et retourne les données associées à l'entité nom (cherche le module de données « Module:Données/nom/évolution population ». Retourne une table contenant les informations stockées, ainsi que certaines autres calculées à partir de celles présentes. Retourne true en deuxième valeur si le chargement s'est bien passé. Sinon à la place retourne un numéro d'erreur (voir le sous-module /Constantes pour les erreurs existantes).
p.variation(data) : retourne la variation de population (par rapport aux données les plus récentes), en pourcentage avec deux chiffres après la virgule, pour l'entité dont les données sont dans data.
p.variation_texte(data) : retourne un texte décrivant la variation de population : « en augmentation/diminution de X % par rapport à AAAA », pour l'entité dont les données sont dans data.
p.valeur_recente(data) : retourne une table contenant l'année et la valeur de la population pour l'entrée la plus récente, pour l'entité dont les données sont dans data.