01. Admin

Software Requirements

Ideally, this section should be populated with the following requirements:

1. Programming language: R, Python or both.
2. Package requirements: exhaustive list of all libraries used in our workflow, including their version.
3. Credentials: are there any environmental variables we need, to ensure confidentiality before public release? How can a member of the team access PositConnect?
4. Data access: in the current version of CLIAR, parts of the data are made available in the repository, and part of it is confidential within the WBG OneDrive. Ideally, all of the data should be removed from the repo, until it is vetted by the MicroData Library.

Workflow

To start developing CLIAR dashboard, please follow the following steps:

1. Clone the repository to your local computer.
2. Install required packages, using the renv package and following these instructions. 2.a. If you are using the World Bank's Windows Laptop, please add the snippet below to your .Rprofile. This will ensure that you download the required files for the package, using a firewall compatible method.

options(renv.download.override = utils::download.file)

3. Request access to data from project administrators. This data folder is stored in the World Bank's OneDrive.
4. Create a separate branch to develop your code base.
5. Once the functionalities are mature and operational, issue a pull request to merge into main.

Expectations

We outline the following expectations for team collaboration:

1. Be kind. We are working together to improve this project, and leading with kindness will ensure that our collaboration occurs in a conducive environment.
2. Be respectful. This means that when you are merging code into main, you are respectful of the reviewer and collaborators. Detail what you are doing, how you are doing it, and convey that in a respectful tone.
3. Be communicative. Open-source development is challenging, in particular for complex environments such as ours. The more you communicate, the better will be your and your team's experience.
4. Be documentation-driven. A key pillar for sustainable and efficient development is proper documentatin. This means both commenting in-line for your code, but also creating business-level documentation to communicate to non-technical audiences.
5. Be reproducible. There are multiple resources available to study and implement reproducibility. Here is a DIME Wiki research approach, and a software development approach.

Conventions

1. All code in this repository will be developed in open-source. This means that R and Python are allowed. This also means that Stata is not allowed, given that it is proprietary (and paid-for) software.
2. Every new feature, including data pipeline and dashboard, will have their own branch on GitHub. This reduces preventable bugs, and keeps our version control clean.