Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pre-commit.ci] pre-commit autoupdate #29

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/project_setup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,4 @@ body:
id: assignment-summary
attributes:
label: Project Assignment
description: Please provide a summary of the project and assignment and, when available, upload work plan shared with client.

description: Please provide a summary of the project and assignment and, when available, upload work plan shared with client.
8 changes: 4 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
Expand All @@ -14,7 +14,7 @@ repos:
args: [--allow-missing-credentials]
- id: detect-private-key
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.39.0
rev: v0.43.0
hooks:
- id: markdownlint
name: Markdownlint
Expand All @@ -24,13 +24,13 @@ repos:
"--disable=MD033", # no-inline-html
]
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
rev: v2.3.0
hooks:
- id: codespell
name: codespell
description: Checks for common misspellings in text files
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.4.1
rev: v0.8.0
hooks:
- id: ruff
types_or: [python, pyi, jupyter]
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ The following datasets are used in this assignmet. Further details about each da

* [BlackMarble](http://blackmarble.gsfc.nasa.gov/) - Visible Infrared Imaging Radiometer Suite (VIIRS) Nighttime Lights from NASA.

* [MODIS](https://modis.gsfc.nasa.gov/) - NASA's 'Modern Resolution Imaging Spectroradiometer' dataset, used to monitor changes in surface vegetation.
* [MODIS](https://modis.gsfc.nasa.gov/) - NASA's 'Modern Resolution Imaging Spectroradiometer' dataset, used to monitor changes in surface vegetation.

* [Veraset Movement Data](https://docs.datapartnership.org/partners/veraset/README.html). Veraset Movement is an unfiltered stream of location and proximity data that Veraset has aggregated from data suppliers. The data can be requested (for purchase) through the [Development Data Partnership](https://datapartnership.org/).



#### Data Availability Statement

Expand Down
18 changes: 9 additions & 9 deletions docs/1-intro-to-data-lab.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction to the Data Lab

The Data Lab supports World Bank operations -- lending, technical assistance, and economic reporting -- by coordinating ad-hoc teams of data analysts and specialists from across our organization. Through the Lab, teams solve global challenges using best practices in coding, code documentation, and data visualization.
The Data Lab supports World Bank operations -- lending, technical assistance, and economic reporting -- by coordinating ad-hoc teams of data analysts and specialists from across our organization. Through the Lab, teams solve global challenges using best practices in coding, code documentation, and data visualization.

Unlike a traditional data analysis, which results in a single-use report or visualization, Data Lab products are designed to be customized, reused, and updated, thereby building the capacity of the World Bank and partner organizations to quickly deliver complex data science solutions to pressing global challenges.

Expand All @@ -18,29 +18,29 @@ Data Lab-supported projects may include:

2. **Analytics**. Leveraging curated datasets, the team conducts analytics across a range of topics (e.g., understanding population movement in response to a crisis or monitoring trends in nighttime lights). Each analysis will include original code, documentation, links to original data sources (and/or information on how to access them), and a description of their limitations. Reference resources are also cited, where relevant.



3. **Additional Resources.** Links and descriptions of additional resources for each project may include:
- Description of common baseline data used to support the analyses -- administrative boundaries, population, infrastructure, etc.
- Description of common baseline data used to support the analyses -- administrative boundaries, population, infrastructure, etc.

- Project SharePoint where original data and documents are maintained.

- Additional static images and data visualizations.
- Additional static images and data visualizations.



4. **Project Team**. For each project, the [World Bank Data Lab](https://wbdatalab.org/) recruits colleagues from throughout the World Bank, pooling our collective data talents in support of our lending and technical assistance operations. Project packages include names and contact information for the unique teams that prepared the analytics.

4. **Project Team**. For each project, the [World Bank Data Lab](https://wbdatalab.org/) recruits colleagues from throughout the World Bank, pooling our collective data talents in support of our lending and technical assistance operations. Project packages include names and contact information for the unique teams that prepared the analytics.



## How Data Lab Projects are Managed

1. **Dynamic, Web-Hosted Documentation**. Unless specified otherwise, all code and documentation used to produce the analytics is hosted in a project GitHub repository to facilitate reuse for future updates and projects, as well as to support collaboration and capacity building activities.



2. **Data Catalogue**. Where possible, all datasets used in the production of Data Goods are added as entries to the World Bank’s [Development Data Hub](https://datacatalog.worldbank.org/home), where they are tagged with meta data, license attributes, and access information.



3. **Internal Project Management and File Sharing System**. To facilitate project management across teams, the Lab creates a Project SharePoint, which includes project management information (work plan, milestones, check-in slides, log of hours charged, final report), related literature, data files, indicator tables, and links to resources, such as this documentation. The advantage of SharePoint for World Bank usage is that all contents are automatically encrypted and tagged as Official Use Only. The project SharePoint is accessible to project team members and, with permission, can be replicated as a basis for future project updates or for similar projects.
18 changes: 9 additions & 9 deletions docs/2-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ All Data Lab analytics include information on data sources, as well as original

1. **Overview**

Summary of the analytical challenge.
Summary of the analytical challenge.




2. **Data Description**
Everything a user would need to access and use the data that supports the analysis. For each source, we include:
Expand All @@ -21,23 +21,23 @@ All Data Lab analytics include information on data sources, as well as original

- Point of Contact



3. **Methodology**
All analytses include step-by-step directions, code snippets, links to complete code, and notes on any critical dependencies. The user should be able to fully understand how the analytical results were achieved and be able to replicate them by following the methodology.
All analytses include step-by-step directions, code snippets, links to complete code, and notes on any critical dependencies. The user should be able to fully understand how the analytical results were achieved and be able to replicate them by following the methodology.




4. **Findings**

This section includes initial results, including statistics, graphs, and maps to illustrate findings.
This section includes initial results, including statistics, graphs, and maps to illustrate findings.




5. **Limitations**

It is critical that all analyses are accompanied by a detailed description of limitations of the data and methodology for interpreting or reproducing results.
It is critical that all analyses are accompanied by a detailed description of limitations of the data and methodology for interpreting or reproducing results.




6. **References and Works Cited**
6 changes: 3 additions & 3 deletions docs/3-add-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Baseline Data**

Each project includes a common set of foundational data that is shared across analytical work, such as administrative boundaries, population, and location of roads and buildings. Following is a summary of baseline data sources for this project.
Each project includes a common set of foundational data that is shared across analytical work, such as administrative boundaries, population, and location of roads and buildings. Following is a summary of baseline data sources for this project.

| Topic | Data Source | Notes |
| ---------------------------------------- | ----------- | ----- |
Expand All @@ -12,10 +12,10 @@ Each project includes a common set of foundational data that is shared across an

**Project Data**

Official-Use-Only original and derived datasets used in the project analytics are made available only to the project team. To request access, World Bank staff can write: [email protected]. Open datasets can be made available thorugh the World Bank's [open data catalog](https://datacatalog.worldbank.org/), at the request of the project team.
Official-Use-Only original and derived datasets used in the project analytics are made available only to the project team. To request access, World Bank staff can write: [email protected]. Open datasets can be made available thorugh the World Bank's [open data catalog](https://datacatalog.worldbank.org/), at the request of the project team.

* [Project Data SharePoint Link](https://worldbankgroup.sharepoint.com/:f:/r/teams/DevelopmentDataPartnershipCommunity-WBGroup/Shared%20Documents/Projects/Data%20Lab/Myanmar%20Economic%20Monitor?csf=1&web=1&e=pyzHxK)

**Other Resources**

​ Additional links or resources are sometimes provided to supplement analytical work.
​ Additional links or resources are sometimes provided to supplement analytical work.
Loading