Skip to content
Phuoc Phung edited this page Nov 27, 2024 · 9 revisions

Welcome to AA service - Data analytics.

This documentation gathers all the codes and documentations around data analyses within AA services.

It is intended for Data and IM who would like to perform analyses about Anticipatory Action. The Pages panel on the right side lists main services of AA. Note that this only contains services that currently have analysis codes, documentations, best practices.

Contributors: all data colleagues who works on data analyses using codes can add, edit the documentation

Editor: AA Data Specialist will refine the documentation to ensure its consistency

Table of Content

How to Contribute

Step 1: Document in your own repository

  1. Set up a github repository for your code. Ask AA Data Specialist (or other DS when AA DS is not available) to create one for you.
  2. Commit your code there. Include a readme.md with these required information:
    • Introduction:
      • Overview on what the code do and expected output
      • Project: project name (link to project in CRM )
      • Contact: github account
    • Data
      • Input: directory, file types, file structure, source/where to download, link to data in Teams
      • Output: directory, file types, link to output in Teams
    • Codes
      • Structure: description of the main code and its function
      • Setup: requirements: packages, python version, etc.
    • How to run the code:
      • step by step e.g. how to call the main function, how to run
  3. Add label aa to this repo to mark it belong to AA, see instruction.

See example: rodekruis/GloFAS-river-depth-analysis

Step 2: Link the code in AA-services-data-analytics Wiki

  1. In Pages panel on the right, find the page (service) where your analysis fall under
  2. Edit the page and add these required information:
    • Title-of-the-analysis
      • Code repository: paste name and link to the repo
      • Overview: paste the introduction of the repo
      • Contact: paste the contact details in the introduction of the repo

See example: Forecast systems skill assessment · rodekruis/AA-services-data-analytics Wiki

Need helps? Contact AA Data Specialist!