Skip to main content

A Python implementation of the Dietary Inflammatory Index (DII) calculator for nutritional epidemiology research

Project description

DII Calculator

PyPI version Python 3.8+ License: MIT

A Python implementation of the Dietary Inflammatory Index (DII) for nutritional epidemiology research.

The Dietary Inflammatory Index is a literature-derived, population-based index that assesses the inflammatory potential of an individual's diet. This package provides a validated implementation for calculating DII scores from nutrient intake data.


Installation

pip install dii-calculator

Quick Start

import pandas as pd
from dii import calculate_dii

# Load your nutrient intake data
nutrients = pd.read_csv("your_data.csv")

# Calculate DII scores
results = calculate_dii(nutrients)
print(results)

Output:

   DII_score
0      -1.23
1       0.45
2       2.87

Interpretation

DII Score Dietary Pattern
Negative (< 0) Anti-inflammatory diet
Near zero Neutral
Positive (> 0) Pro-inflammatory diet

Scores typically range from -8 (maximally anti-inflammatory) to +8 (maximally pro-inflammatory).


Features

Detailed Output

Get per-nutrient contributions to understand what's driving the score:

detailed = calculate_dii(nutrients, detailed=True)
print(detailed[["Fiber_contribution", "Saturated fat_contribution", "DII_score"]])

Visualization

from dii import plot_dii_distribution, plot_nutrient_contributions

plot_dii_distribution(results)
plot_nutrient_contributions(detailed)

DII Score Distribution

Command Line

dii input.csv -o results.csv
dii input.csv --detailed
dii --nutrients  # List supported nutrients

Input Format

Your DataFrame should have columns matching DII nutrient names. The package supports all 45 DII parameters:

participant_id,Fiber,Alcohol,Vitamin C,Saturated fat,Energy
1,18.8,13.98,118.2,28.6,2056
2,25.0,0.0,150.0,22.0,1800

Run dii --nutrients to see all supported nutrients and their units.

Note: Nutrients not in your data are automatically excluded from the calculation.


Validation

Validated against 13,580 NHANES participants with perfect match to the dietaryindex R package.


Citation

If you use this package in your research, please cite:

@software{clark2025dii,
  author = {Clark, Ted and Strath, Larissa},
  title = {dii-calculator: Dietary Inflammatory Index Calculator for Python},
  year = {2025},
  url = {https://github.com/strathlab-data/DII}
}

Also cite the original DII methodology:

Shivappa N, Steck SE, Hurley TG, Hussey JR, Hébert JR. Designing and developing a literature-derived, population-based dietary inflammatory index. Public Health Nutr. 2014;17(8):1689-1696.


License

MIT License — see LICENSE for details.


Authors

  • Ted Clark — University of Florida
  • Larissa Strath, PhD — University of Florida

Department of Health Outcomes and Biomedical Informatics

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dii_calculator-1.0.4.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dii_calculator-1.0.4-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file dii_calculator-1.0.4.tar.gz.

File metadata

  • Download URL: dii_calculator-1.0.4.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for dii_calculator-1.0.4.tar.gz
Algorithm Hash digest
SHA256 7a95db0706d9249bb40428467c07849760010329f029819b31df1390fbc06c57
MD5 ed90aec2d679d02b5d25d1afc3a7b71c
BLAKE2b-256 9bff6b2992d0e03a9d094e03e1eee8e8bbe097e4d5fe32e847289009bf4a3093

See more details on using hashes here.

File details

Details for the file dii_calculator-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: dii_calculator-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for dii_calculator-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 77026b2294dc90815af3bee4ab01c477a760f06c9769ddeb899f1f73f6ae67d3
MD5 08b721c688fb98a176844eaf57242f2f
BLAKE2b-256 4499c3a9bf88d5e9179356b8af1d477ed7962f2796284e62171c263e0f2478bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page