tiphaine/o2-base

Collection of useful and heterogeneous data.

o2-base

Collection of useful and heterogeneous data.

Usage

---

• All data

  make data_all

• INSEE data

  • population counts
  • confiance des ménages
  • climat des affaires
  • couple-famille-menages (France / ex: 2016)
  • diplome-formation (France / ex: 2016)

  make data_insee

• CAF data

  • allocations foyers bas revenus

  make data_caf

• LA POSTE data

  • base des codes postaux

  make data_laposte

• Miscellaneous data

  • IDH2 en Ile de France

  make data_misc

• World Bank data

  • Inflation, consumer prices (annual %)

  make data_world_bank

• European Central Bank

  • FOREX for Euros/ Euro foreign exchange reference rates

  make data_ecb

How to add a new data source

• Sourcing / Put the url in data/<data_source_name>/source_config.py (url, raw and processed file)
• Downloading / Add the function to download the data in data/<data_source_name>/get_data.py*
• Formatting final data / Add the function to format and write the final data in data/<data_source_name>/make_data.py*
• Automating / Add the automation lines in the data/make_dataset.py script and in the Makefile
• Documentation and usage / Add the Makefile command in the Usage section of the README.md file with the url of the source
• Don't forget to document your functions !
• And, you're done !

* It is good practice to rely on existing functions from data/utils.py and data/helpers.py to download and write files.