Skip to contents

humind

humind provides functions to compose common humanitarian composite indicators related to IMPACT Multi-Sector Needs Assessments (MSNAs), including:

  • MSNI framework indicators: sectoral composites, MSNI metrics, and all required recoding
  • Food security indicators: rCSI, LCSI, HHS, FCS
  • WASH indicator recoding to JMP classifications

The package follows the Step – Composition approach of the IMPACT R framework.

Installation

Install the latest tagged release from GitHub:

# install.packages("devtools")
devtools::install_github("impact-initiatives-hppu/humind@v2025.1.3")

Verify the version:

packageVersion("humind")
# v2025.1.3

📚 Guidance Note

A comprehensive Guidance Note is available here.
It provides essential background on the MSNI framework and sector-specific guidance. Each sector includes a “Humind Data Workflow” describing required steps and the relevant humind functions.

⚠️ Read the Guidance Note thoroughly—especially the Data Workflow sections—before implementing analyses with humind.

📌 A technical documentation guide (full MSNI workflow with runnable examples) will be added to this repository.

📖 2025 Programmatic Changes

Cross-cutting

  • Terminology migration: acute need → severe need (functions and outputs).

MSNI & Sectoral Composites

  • Consistent renaming of *_in_acute_need → *_in_severe_need across all domains.

Protection

  • Complete revamp based on a new series of Tier 1 indicators related to Protection needs.
  • Refined NA handling in rights and practices composites: DNK/PNTA no longer collapse the entire composite; only affected sub-scores are nullified.

WASH

  • Expanded handwashing facility categorization via add_handwashing_facility_cat() with explicit soap-type handling and harmonized observed vs. reported rules.
  • Incorporated self-reported hygiene variants (availability of soap & water) and mapped them to JMP classifications.

Health

SNFI

  • Shelter issues increased from 8 to 11 and remapped to the framework.
  • Added one indicator to the security of tenure dimension: hlp_eviction_risk.
  • Hygiene indicator removed from the FDS series; domestic tasks (incl. lighting) now total 4 (was 5).
  • Optional shelter damages component added.

Food Security

  • New analysis step to assess the impact of livelihood coping strategies on Food Consumption (implemented in impactR4PHU and reflected in humind).

Education

  • Indicator renamed from edu_disrupted_occupation to edu_disrupted_attack to reflect “direct attack on education”.

⚠️ Breaking Changes

2025.1.3

No breaking changes

2025.1.2

Function rename

Output schema

  • All *_in_acute_need outputs → *_in_severe_need
    (MSNI, WASH, Health, Food Security, SNFI, Education, Protection).

WASH

  • add_comp_wash() default parameter: drinking_water_quantity now defaults to wash_hwise_drink (was wash_drinking_water_quantity).
  • add_handwashing_facility_cat() now requires soap-type columns/args (soap_type_observed, soap_type_reported) and accepts vectorized “no” codes.
  • Classification rules tightened: non-qualifying or undefined soap types demote basic → limited; NA handling stricter in reported path.

Protection

  • DNK/PNTA handling refined: composites are NA only if both sub-dimensions are NA.

Healthcare

📌 Issues and Feedback

Choose the appropriate template when opening an issue:

Not sure where it fits?
Open a blank issue with as much detail as possible.

⚠️ Known Issues

GitHub Credentials Error When Installing with devtools

When installing with devtools::install_github(), you may encounter:

> devtools::install_github("impact-initiatives-hppu/humind@v2025.1.3")
...
Error : Failed to install 'unknown package' from GitHub:
  HTTP error 401.
  Bad credentials

This is typically caused by outdated or incorrect GitHub credentials stored in R. Public repositories do not require credentials. To resolve:

library(gitcreds)
gitcreds_delete()

Then retry the installation.

License

humind is released under the MIT License.