Giter Site home page Giter Site logo

yingqq / big-mac-data Goto Github PK

View Code? Open in Web Editor NEW

This project forked from theeconomist/big-mac-data

0.0 0.0 0.0 6.13 MB

Data and methodology for the Big Mac index

Home Page: https://www.economist.com/bigmac

License: MIT License

Jupyter Notebook 99.55% R 0.45%

big-mac-data's Introduction

The Big Mac index

This repository contains the data behind The Economist’s Big Mac index, and code that shows how we calculate it. To download the data, go to the latest release, where you can download the index data in a CSV or Excel, or the code behind it.

Source data

Our source data are from several places. Big Mac prices are from McDonald’s directly and from reporting around the world; exchange rates are from Thomson Reuters; GDP and population data used to calculate the euro area averages are from Eurostat and GDP per person data are from the IMF World Economic Outlook reports.

Output data

The script provides data in three files:

  • big-mac-raw-index.csv contains values for the “raw” index
  • big-mac-adjusted-index.csv contains values for the “adjusted” index
  • big-mac-full-index.csv contains both

Each file also contains the source data used to calculate it.

Codebook

This codebook largely applies to all three files. The exception is the variables suffixed "_raw" or "_adjusted"—these appear (with suffixes) in the "full" file but without suffixes in the respective ("raw" or "adjusted") files.

variable definition source
date Date of observation
iso_a3 Three-character ISO 3166-1 country code
currency_code Three-character ISO 4217 currency code
name Country name
local_price Price of a Big Mac in the local currency McDonalds; The Economist
dollar_ex Local currency units per dollar Reuters
dollar_price Price of a Big Mac in dollars
USD_raw Raw index, relative to the US dollar
EUR_raw Raw index, relative to the Euro
GBP_raw Raw index, relative to the British pound
JPY_raw Raw index, relative to the Japanese yen
CNY_raw Raw index, relative to the Chinese yuan
GDP_dollar GDP per person, in dollars IMF
adj_price GDP-adjusted price of a Big Mac, in dollars
USD_adjusted Adjusted index, relative to the US dollar
EUR_adjusted Adjusted index, relative to the Euro
GBP_adjusted Adjusted index, relative to the British pound
JPY_adjusted Adjusted index, relative to the Japanese yen
CNY_adjusted Adjusted index, relative to the Chinese yuan

Calculating the Big Mac index

The code to calculate the index is provided as a Jupyter Notebook. The code itself is written in R, a programming language designed for data manipulation and statistics. You can view the notebook on github.

If you want to run the notebook, you’ll need to set up a few things:

Install Python

You can refer to the installation instructions at the Hitchhiker’s Guide to Python

On a Mac, you already have Python 2.7 installed, but it does not come with Python’s package manager. We recommend using Python 3. To install it, we recommend using Homebrew. In terminal, install Homebrew:

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Then, use Homebrew to install Python 3.x:

$ brew install python3

On Ubuntu Linux you can use aptitude:

$ sudo apt-get update
$ sudo apt-get install python3.6

On Windows, instructions coming.

Install Jupyter

On Mac or Linux, you should now also have pip installed. pip is a package manager for Python. You can install Jupyter with pip:

$ python3 -m pip install jupyter

You’re all set. (If you are using Python 2, run python -m pip install jupyter.)

On Windows, instructions coming.

Install R

On a Mac, use Homebrew again. At a terminal prompt, run:

$ brew install R

On Ubuntu Linux, you’re recommended to add a new source to your aptitude setup to install R. Run:

$ sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E298A3A825C0D65DFD57CBB651716619E084DAB9

Once you have added the key, add R repository (called CRAN):

$ sudo add-apt-repository 'deb [arch=amd64,i386] https://cran.rstudio.com/bin/linux/ubuntu xenial/'

Now, you can install R:

$ sudo apt-get update
$ sudo apt-get install r-base

On Windows, instructions coming.

Install IRkernel

IRKernel lets you run R code in Jupyter notebooks. This is the best way to work with R code (this is a truth not yet universally acknowledged). Installation instructions for IRKernel are here. In short:

At a terminal prompt, start R:

$ R
> install.packages(c('repr', 'IRdisplay', 'evaluate', 'crayon', 'pbdZMQ', 'devtools', 'uuid', 'digest'))
> devtools::install_github('IRkernel/IRkernel')
> IRkernel::installspec()

Congratulations, you can run R in Jupyter.

Install tidyverse and data.table

Finally, our R script uses a few R packages you’ll need to install. The tidyverse is a collection of useful packages for data science work in R. Data.table is a complicated but extremely useful alternative to R’s standard data frames for storing and manipulating data. At the R prompt from above, run:

> install.packages(c('tidyverse','data.table'))

You’re all set.

Start the notebook

Navigate to the repository on the command line, and run:

$ jupyter notebook

You should see a browser window pop up on http://localhost:8888. Click on “Big Mac data generator” to launch the notebook.

To run the notebook, you can run the code cell by cell by clicking on the first cell and using shift+enter to run each cell in turn. Or you can run the whole thing by clicking on the “Cell” menu and selecting “Run All”.

R script

We also include the calculation as a bare R script (data-generator.R) if you just want to run the code, but this doesn't explain what the code does or walk you through it. To run this, you'll only need to install R, tidyverse, and data.table; once those are installed, you can just run

$ R data-generator.R

to calculate the index files. (The R script may generate numbers that are different at the last decimal place to those from the Python notebook—these differences are due to rounding errors and can be safely ignored.)

Licence

This software is published by The Economist under the MIT licence. The data generated by The Economist are available under the Creative Commons Attribution 4.0 International License.

The licences include only the data and the software authored by The Economist, and do not cover any Economist content or third-party data or content made available using the software. More information about licensing, syndication and the copyright of Economist content can be found here.

big-mac-data's People

Contributors

futuraprime avatar marie-ella avatar martgnz avatar roxwillis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.