MIS3011S Project Specification

MIS3011S
Project Specification

1 Description

Design a computer program, written in Python 3, that reads world happiness index data from the provided csv file, and allows exploration of that data by the user.

2 Requirements

To be a successful project, your program must:

• Read sales data from a CSV (comma-separated values) file called “world_happiness_index_2013_2023.csv” and load it into an appropriate data structure(s):

– About Dataset

Originally Taken from http://worldhappiness.report/ (Collaborator: Joakim Arvidsson). This work is licensed under the Community Data License Agreement - Permissive - Version 1.0.

https://www.kaggle.com/datasets/joebeachcapital/world-happiness-report-2013-2023

• The user is presented with a menu that has the following options to perform his/her query:

1. The top 3 to 10 happiest countries for a certain year. (eg. 2015), as well as an option for the 3 least happiest countries for that year. The latter is optional but should be provided to the user as a choice.
2. The top 3 countries that have gotten 1st in the happiness index for all the data provided the most number of times, as well as the 3 unhappiest countries based on happiness index the most number of times.
3. Choose a country and show for a period (based on user’s choice, last 3, 5 or 10 years) whether the country has been increasing its rank or decreasing its rank.
4. List the countries by name sorted in alphabetical order in ascending order/descending order. The default is ascending order, the descending order is a choice.
5. Choose countries with at least a certain index. The user can opt for a higher end, but it is optional. List these countries in descending order according to index.
6. Group countries by rank ranges in multiples of 10 (1 to 10, 11 to 20…) for the last 5 years in ascending order by rank.
7. List the countries that have at least 3 consecutive years of lower ranks for any frame of time. (Think about 2014, how do you handle that?)
8. For all options stated above, the user can choose a specific country from the filtered list and drill into the details such as:

• the average rank, the range of its rank,

• the range of its indexes,

• the standard deviation of its indexes.

• the years which the country has gotten the lowest rank and the highest rank.

• Be easy to use, verbose.

• Use modular program design.

• Employ sensible naming of variables, functions, modules, etc;

• Employ extensive (but clear) use of comments.

• Use only the following packages (and only if required):

– math;

– sys;

– os.

• Use only data types seen in the lectures (no dictionaries, classes, etc).

2.1 Extra Functionality

To increase the quality of your project, several of the following extras can be attempted. This list is not definite, and any extra features (not listed here) that will add value to the program, and thus will improve the final evaluation of your work.

The program can also:

• Allow choice of input data file name;

• Be robust (should not crash with unexpected input data):

– type detection;

– wrong menu options;

– wrong filename;

– . . .

• Provide other statistical measures;

• Provide a way to save a data analysis overview as a separate text file;

• Provide a pleasant interface.

2.2 World Happiness Index Data

To download the original data file, you will have to sign up an account with kaggle.com and use the following URL

https://www.kaggle.com/datasets/joebeachcapital/world-happiness-report-2013-2023

The sample provided in the assignment is a snapshot of the original downloaded data. For this assignment, you would only need the file provided.

3 Deliverables

The following deliverables are required (2 PDF files and all Python code):

• A User Manual (PDF file), containing instructions on how to use the software;

• a Code Manual (PDF file), containing:

– An upper level UML Activity Diagram, describing the main functionality and flow control of the program;

– A full print-out of the commented code.

• Source code (one or more Python files).

All deliverables must be submitted through Brightspace.

4 Evaluation

The projects will be evaluated after submission. Evaluation will consist of a short interview with all team members, to demonstrate the final software, and discuss and justify the design and programming choices made. Each student will be asked questions in turn, concerning both the functionality of the program, and the Python source code.# MIS3011S_Group2
USER MANUAL
Introduction
The Happiness Index Analyzer is a Python program designed to analyse data from a CSV file
containing information about the happiness index of countries over the years. The program
provides various functionalities to explore and understand the data, including identifying
top and least happiest countries, analysing trends, and obtaining detailed information about
specific countries.
To install and run the program, follow these instructions:

1. Ensure you have Python installed on your system.
2. Download the program files (CSV file and Programming script)
3. Open a terminal or command prompt.
4. Navigate to the directory containing the program files.
5. Run the program and ensure both the programming script and CSV files are in the
   same folder.
   Input Requirements:
   The input CSV file should follow the format – Country, Year, Index, Rank.
   Example: Country 1, 2019, 7.6, 4
   Ensure that the CSV file is correctly formatted and contains necessary columns. During
   program execution, follow on-screen prompts for additional input.
   Menu Options:
6. Happiest/Unhappiest Countries in Selected Year
   • Displays top 3 & 10 happiest countries and top 3 unhappiest countries.
7. Most Frequent Happiest/Unhappiest Countries of all time
   • Displays top 3 happiest & unhappiest of all time
8. Rank Trend for Selected Country
   • Display the trend of the country that was inputted by user, over the span of
   selected years.
9. List Countries Alphabetically
   • Display the list of countries arranged alphabetically and selected order of
   either ascending or descending.
10. Show Countries above Index 5 in Descending Order
    • Display countries with an index that is above the threshold which is
    determined by user.
11. Show countries by Rank Ranges in multiples of 10 (Last 5 Years)
    • Display countries in groups of 10, grouping based on their ranks for the
    past 5 years. (starting from 2019, 2020, 2021, 2022, 2023)
12. Consecutive 3 Years in Lower Ranks
    • Display list of countries that is ranked bottom for 3 consecutive years.
13. Drill into Details of Selected Country
    • Display list of information on the country which the user inputs,
    information such as the rank range, average rank, index ranges etc.
    Troubleshooting:
    Ø Error: The file ‘data.csv’ does not exist.
    • Resolution: Ensure the file path is correct and the file exists.
    Ø Invalid choice. Please enter a number between 0 and 8.
    • Resolution: Make sure to enter a valid menu option
    Exiting the program:
    To exit the program, enter ‘0’when prompted for a choice. The program will display a
    goodbye message