SCL Data - Data Ecosystem Working Group
Table of Contents:
Objective and context
Important: This package is in the development phase
The objective of this tool is to help users access standardized SCLdata indicators on topics such as poverty, inequality, health, labor market, gender and diversity, education, and migration for the 26 countries of the region. This tool will be developed to facilitate the consultation of the region's indicators, providing a unified source of data on different topics that can be easily used to generate comparative analyses or studies on the region. This will boost knowledge about the region, facilitating decision-making with a reliable and comparable source of information for the countries of Latin America and the Caribbean.
The project to develop the library in Python resulted from the implementation workshop for IDBSocialData. Individual developers showed interest in the library in Python and decided to collaborate voluntarily with the IDB to develop this tool. At the end of the project, all the developers who participate will be included in the package as authors.
Collaboration
Structure
To keep the work structured, the repository will have two main branches: 1) main and 2) development that helps to minimize errors and make the work more effective:
1) Main: The version contained in this Branch is always the most current version and the one which is reviewed and approved to run. This Branch should not be modified unless all changes are approved in the Development Branch.
2) Development: This Branch is designated to test the changes or additions made to the scripts. From this Branch, we will create individual branches to do given tasks.
Because the work will be done simultaneously by several developers, it is required that each one works with a personal branch where the required feature is solved or worked on and the following steps must be followed:
-
To work on the feature, a Branch that is a copy of the Development version must be created.
-
Once the process of modification or adjustment of the scripts is finished, the pull request must be made to perform the merge. The merge must always be requested with the Development branch.
-
Once the merge request is made, it is reviewed and verified that there are no errors in the new pull. Then the pull and merge will be done with the main Branch.
Language
To keep things as neat as possible and to maximize the reach of the library, we will use English for all contributions.
Road-map
To make the work more effective the roadmap to develop this library will be based on the R package idbsocialdataR. We will work to replicate the different functions in the R package.
The functions are ordered by importance, thus we will start working from the top and move to the bottom.
| Function | Objective | Status | Developer |
|---|---|---|---|
| iadburls | Function to get urls of the API | Done | Genrry |
| query_indicator | Main function, query indicators | To do | Not assigned |
| query_dictionary | See available indicators | To do | Not assigned |
| get_countries | Search available countries | To do | Elena, Juan Pablo |
| get_themes | Search available topics | To do | Not assigned |
| search_indicator | Give string to search within the dictionary for an indicator | To do | Not assigned |
| get_sources | Get available sources | To do | Not assigned |
| idbsocial_plot | Create plot | To do | Juan & Sergio |
| get_map | Get a map from regions | To do | Juan & Sergio |
| idbsocial_choropleth | Create a map with indicator | To do | Juan & Sergio |
The developers will choose a function/functions, via slack, and we will create the repository's project and assign the tasks to have control and avoid repetitions.
Authors
This section will be added when we finish the library.
