HDX Signals

HDX Signals is a product of HDX that monitors key datasets and generates automated emails when significant, negative changes are detected.

Find all code and technical documentation behind HDX Signals in this repository. Read more about HDX Signals and sign up to receive signals direct in your inbox on our website. See our methodology documentation for details on datasets included and how signals are generated.

Overview

The code is structured as below. Refer to the directories for specific details.

• src: All source code for scanning all datasets, generating signals content, sendin emails through Mailchimp, and interacting with the cloud store.
• src-static: Source code for generating static assets such as metadata for locations covered in Signals, spatial files for use in maps, and other resources utilized in src.
• test: Unit testing utilities for code and manual testing to explore changes to visual design in the system.
• .github: Workflows that automate data scanning and other processes.

Environment

{renv} is used for package management. {box} is used for module importation. More details on their usage in contributing. See all required environment variables and brief descriptions in ENVIRONMENT.md.

Contributing

See CONTRIBUTING.md for details on coding practices for the system and how to contribute.

Changes

All changes to the repository are tracked in CHANGES.md.

License: GPLv3