Skip to content

Commit

Permalink
Proofreading
Browse files Browse the repository at this point in the history
  • Loading branch information
g4brielvs committed Feb 15, 2024
1 parent 43a5c33 commit dc03121
Show file tree
Hide file tree
Showing 17 changed files with 658 additions and 2,086 deletions.
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,6 @@ target/
# Mypy cache
.mypy_cache/

# Jupyter Book
_build/
# Project-specific
_build/
data/
39 changes: 39 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- id: check-ast
- id: check-json
- id: detect-aws-credentials
args: [--allow-missing-credentials]
- id: detect-private-key
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.39.0
hooks:
- id: markdownlint
name: Markdownlint
files: \.(md|mdown|markdown)$
args: [
"--disable=MD013", # line-length
"--disable=MD033", # no-inline-html
]
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
name: codespell
description: Checks for common misspellings in text files
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.2.1
hooks:
- id: ruff
types_or: [python, pyi, jupyter]
args: [--fix]
- id: ruff-format
types_or: [python, pyi, jupyter]
8 changes: 0 additions & 8 deletions Makefile

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Restrictions may apply to the data that support the findings of this study. Data

## License

The repository is licensed under the [World Bank Master Community License Agreement](LICENSE.md).
This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.
5 changes: 4 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Book settings
title:
author: World Bank Development Data Group
author: Development Data Group
copyright: "2023"
logo: docs/images/logo.png
only_build_toc_files: true
Expand All @@ -17,6 +17,9 @@ html:
use_issues_button: true
baseurl: https://datapartnership.github.io/turkiye-earthquake-impact
extra_footer: |
<div>
Country borders or names do not necessarily reflect the World Bank Group’s official position. All maps are for illustrative purposes and do not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries
</div>
<div>
<b>All content (unless otherwise specified) is subject to the <a href="https://www.mozilla.org/en-US/MPL">Mozilla Public License.</a></b>
</div>
Expand Down
8 changes: 3 additions & 5 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,10 @@ parts:
- caption: Introduction to Data Goods
chapters:
- file: docs/introduction_to_data_goods
- caption: Foundational Datasets
chapters:
- file: docs/foundational_datasets_and_data_products.md
- file: notebooks/earthquake-intensity/earthquake_intensity.ipynb
- file: docs/data
- caption: Data Products
chapters:
- file: notebooks/earthquake-intensity/earthquake_intensity.ipynb
- file: notebooks/business-activity-trends/README
sections:
- file: notebooks/business-activity-trends/01-business-activity-trends.ipynb
Expand All @@ -28,7 +26,7 @@ parts:
- file: notebooks/nighttime-lights/README
- file: notebooks/surveys/README
sections:
- file: notebooks/surveys/premise.ipynb
- file: notebooks/surveys/premise.ipynb
- caption: Sample Indicators and Insights
chapters:
- file: docs/sample-indicators
Expand Down
1 change: 0 additions & 1 deletion docs/bibliography.bib
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,3 @@ @inproceedings{10.1145/3292500.3340412
location = {Anchorage, AK, USA},
series = {KDD '19}
}

15 changes: 8 additions & 7 deletions ...oundational_datasets_and_data_products.md → docs/data.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
(foundational-data)=
# Foundational Datasets and Data Products Summary
# Datasets and Data Products Summary

## Foundational Datasets
(data)=

**Foundational Datasets** refer to **all** datasets used in the analytics prepared for a project. The Foundational Datasets table includes a description of the data and their update frequency, as well as access links and contact information for questions about use and access. Users should not require any datasets not included in this table to complete the analytical work for the Data Good.
## Datasets

Following is list of all Foundational Datasets used in this Data Good:
**Datasets** refer to **all** datasets used in the analytics prepared for a project. The Datasets table includes a description of the data and their update frequency, as well as access links and contact information for questions about use and access. Users should not require any datasets not included in this table to complete the analytical work for the Data Good.

Following is list of all Datasets used in this Data Good:

```{note}
**Project Sharepoint** links are only accessible to the project team. For permissions to access these data, please write to the contact provided. The **Development Data Hub** is the World Bank's central data catalogue and includes meta-data and license information.
Expand All @@ -26,11 +27,11 @@ Where feasible, all datasets that can be obtained through the Development Data H

## Data Products Summary

**Data Products** are produced using the **Foundational Datasets** and can be further used to generate indicators and insights. All Data Products include documentation, references to original data sources (and/or information on how to access them), and a description of their limitations.
**Data Products** are produced using the **Datasets** and can be further used to generate indicators and insights. All Data Products include documentation, references to original data sources (and/or information on how to access them), and a description of their limitations.

Following is a summary of Data Products used in this Data Good:

| ID | Name | Description | Limitations | Foundational Datasets Used (ID#) |
| ID | Name | Description | Limitations | Datasets Used (ID#) |
| --- | ---- | ----------- | ----------- | -------------------------------- |
| A | Observed POI Visitation based on mobility traces | Daily aggregated analysis of trip patterns through formal and informal checkpoints, over time. | Convenience sampling; Sample size is limited | 1,2 |
| B | Observed changes in Business Activity Trends | Daily and weekly aggregated business activity trends per business vertical | Only uses data from Facebook users | 1, 4 |
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
docutils==0.17.1
jupyter-book==0.15.1
jupyter-book==0.15.1
6 changes: 2 additions & 4 deletions docs/sample-indicators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Indicators** can be derived from a combination of **Foundational Datasets** and **Data Products**. By combining Foundational Datasets and Data Products, teams can, on-demand, develop a large array of indicators to meet their project needs. Indicators can presented side-by-side in an Excel workbook -- a format that is generally accessible to the widest audiences. Because all indicators are based on the same underlying data, they are comparable with each other, across geographies and across time.

For this project, sample indicators have been derived and aggregated at the Admin 2 level over multiple time periods, to show changing trends in each area over time. Here is a link to the [**Indicators Excel workbook**](https://worldbankgroup.sharepoint.com/:x:/t/DevelopmentDataPartnershipCommunity-WBGroup/EUeOvCYy-J5Any7OhhspubQBbykjOv0ew9MAZg4oGz2i3w?e=De1jpa) (accessible to team members via SharePoint), and following is a summary of the sample indicators by Administrative Level 2, over a baseline and weekly post-earthquake periods:
For this project, sample indicators have been derived and aggregated at the Admin 2 level over multiple time periods, to show changing trends in each area over time. Here is a link to the [**Indicators Excel workbook**](https://worldbankgroup.sharepoint.com/:x:/t/DevelopmentDataPartnershipCommunity-WBGroup/EUeOvCYy-J5Any7OhhspubQBbykjOv0ew9MAZg4oGz2i3w?e=De1jpa) (accessible to team members via SharePoint), and following is a summary of the sample indicators by Administrative Level 2, over a baseline and weekly post-earthquake periods:

* Population

Expand All @@ -21,8 +21,6 @@ For this project, sample indicators have been derived and aggregated at the Admi

### Sample indicator: Observing change in Business Activity for a specific business vertical

By overlaying multiple datasets together, it is possible to study changes in business activity further. For instance, in the below map, we can see the changes in Business Activity for the retail sector overlayed with damaged buildings information from the MoECC. Some admin 2 regions' retail activity remained relatively unaffected immediately after the earthquake despite damage to buildings.
By overlaying multiple datasets together, it is possible to study changes in business activity further. For instance, in the below map, we can see the changes in Business Activity for the retail sector overlayed with damaged buildings information from the MoECC. Some admin 2 regions' retail activity remained relatively unaffected immediately after the earthquake despite damage to buildings.

<iframe width="100%" height="500px" src="https://studio.foursquare.com/public/1a818869-6a2e-41a9-a261-2aec58cf468e/embed" frameborder="0" allowfullscreen></iframe>


2 changes: 1 addition & 1 deletion docs/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ The Data Lab would like to express our sincere gratutude and appreciation for th
| [Gabriel Stefanini Vicente](mailto:gvicente@worldbank.org) | Data Scientist - Cross border activity monitoring using GPS data | WB Data Lab, DECDG |
| [Sahiti Sarva](mailto:ssarva@worldbank.org) | Data Scientist - Internet Connectivity, Business Activity Trends, Premise surveys, Access, code and data management | WB Data Lab, DECDG |

The Data Lab would also like to express our appreciation for Han Anand Beck, Lead Country Economist for Turkiye, who has entrusted our team with using alternative data sources to understand a rapidly changing, complex problem.
The Data Lab would also like to express our appreciation for Han Anand Beck, Lead Country Economist for Turkiye, who has entrusted our team with using alternative data sources to understand a rapidly changing, complex problem.
9 changes: 0 additions & 9 deletions environment.yml

This file was deleted.

Loading

0 comments on commit dc03121

Please sign in to comment.