[Suggestion] Améliorer les noms de variables et de colonnes des dataframe

mobility-team / mobility

Mobility, an open-source library for mobility modelisation

MIT License

16 stars 10 forks source link

[Suggestion] Améliorer les noms de variables et de colonnes des dataframe #26

Open FlxPo opened 1 year ago

FlxPo commented 1 year ago

Le travail sur https://github.com/mobility-team/mobility/issues/19 m'a fait repenser au besoin d'avoir de meilleurs noms pour les variables que l'on utilise, et notamment les noms de colonnes des dataframes : mode_id, ef, ef_name...

Préfixe "mobility", "ademe", "sdes_"... pour expliciter la source ?
Acronymes autorisés ou noms complets systématiquement ?

Preneur de vos idées @Mind-the-Cap @louisegontier

Mind-the-Cap commented 1 year ago

Pourquoi pas commencer par la source en effet ! Je propose source_type_précision ou catégorie, par exemple insee_flow_work-home ou ademe_co2-per-km_train
Les acronymes et sigles courants doivent être autorisés pour maintenir des variables courtes (ADEME, TGV...) mais tous ceux non triviaux devraient être explicités, dans l'esprit de PEP8