Kossisoroyce commited on
Commit
39c10a8
·
verified ·
1 Parent(s): 4fb28c3

Add master datacard from README_Water.md

Browse files
Files changed (1) hide show
  1. README.md +113 -0
README.md ADDED
@@ -0,0 +1,113 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Master Datacard for Water Indicators for African Countries
2
+
3
+ This repository contains time-series datasets for key water-related indicators for 54 African countries. The data is sourced from The World Bank and has been cleaned, processed, and organized for analysis.
4
+
5
+ Each country has its own set of files, including a main CSV dataset and a corresponding datacard in Markdown format. The data covers the period from 1960 to 2024, where available.
6
+
7
+ ---
8
+
9
+ ## Repository Structure
10
+
11
+ The datasets are organized by country. Each country's folder contains:
12
+
13
+ 1. A CSV file with the naming convention: `{CountryName}-Water-Indicators-Dataset-{StartYear}-{EndYear}.csv`
14
+ 2. A detailed datacard named `datacard_Water.md`.
15
+
16
+ ---
17
+
18
+ ## Indicators Included
19
+
20
+ This collection includes the following water indicators:
21
+
22
+ - Annual freshwater withdrawals, total (% of internal resources)
23
+ - Marine protected areas (% of territorial waters)
24
+ - People using at least basic drinking water services (% of population)
25
+ - People with basic handwashing facilities including soap and water (% of population)
26
+
27
+ ---
28
+
29
+ ## Countries Included
30
+
31
+ This dataset covers all 54 sovereign nations of Africa as recognized by the source data:
32
+
33
+ - Algeria
34
+ - Angola
35
+ - Benin
36
+ - Botswana
37
+ - Burkina Faso
38
+ - Burundi
39
+ - Cabo Verde
40
+ - Cameroon
41
+ - Central African Republic
42
+ - Chad
43
+ - Comoros
44
+ - Congo, Dem. Rep.
45
+ - Congo, Rep.
46
+ - Cote d'Ivoire
47
+ - Djibouti
48
+ - Egypt, Arab Rep.
49
+ - Equatorial Guinea
50
+ - Eritrea
51
+ - Eswatini
52
+ - Ethiopia
53
+ - Gabon
54
+ - Gambia, The
55
+ - Ghana
56
+ - Guinea
57
+ - Guinea-Bissau
58
+ - Kenya
59
+ - Lesotho
60
+ - Liberia
61
+ - Libya
62
+ - Madagascar
63
+ - Malawi
64
+ - Mali
65
+ - Mauritania
66
+ - Mauritius
67
+ - Morocco
68
+ - Mozambique
69
+ - Namibia
70
+ - Niger
71
+ - Nigeria
72
+ - Rwanda
73
+ - Sao Tome and Principe
74
+ - Senegal
75
+ - Seychelles
76
+ - Sierra Leone
77
+ - Somalia
78
+ - South Africa
79
+ - South Sudan
80
+ - Sudan
81
+ - Tanzania
82
+ - Togo
83
+ - Tunisia
84
+ - Uganda
85
+ - Zambia
86
+ - Zimbabwe
87
+
88
+ ---
89
+
90
+ ## Data Preparation
91
+
92
+ The raw data from The World Bank was processed using a Python script with the following steps:
93
+
94
+ 1. **Filtering**: Data was filtered for each of the 54 African countries.
95
+ 2. **Reshaping**: Wide-format data (with years as columns) was melted into a long format.
96
+ 3. **Merging**: All indicator files for a country were merged into a single time-series dataset based on the 'Year' column.
97
+ 4. **Cleaning**: The 'Year' column was converted to a standard date format (`YYYY-MM-DD`).
98
+ 5. **Missing Data Handling**: Gaps in the time-series were filled using linear interpolation followed by a back-fill to ensure data continuity.
99
+
100
+ ---
101
+
102
+ ## How to Use
103
+
104
+ You can access the data directly through the Hugging Face Hub, either by downloading individual files or by using the `datasets` library to load the data.
105
+
106
+ ```python
107
+ from datasets import load_dataset
108
+
109
+ # Example: Load the dataset for Nigeria
110
+ dataset = load_dataset('electricsheepafrica/Water-Indicators-For-African-Countries', data_files='Nigeria/Nigeria-Water-Indicators-Dataset-1960-2024.csv')
111
+
112
+ print(dataset)
113
+ ```