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.6.tar.gz (19.5 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.6-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dii_calculator-1.0.6.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dii_calculator-1.0.6.tar.gz
Algorithm Hash digest
SHA256 ce27e0de6621669de29ac6bf3b763d55342ae73b38ca69320e60a59ac9fd6598
MD5 984501bcadf91ccca023f316cdc758e0
BLAKE2b-256 be4b39bc6989aef71173567bb35f94c498f4574a3741fd440cbd89e82c3e27d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for dii_calculator-1.0.6.tar.gz:

Publisher: publish.yml on strathlab-data/DII

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: dii_calculator-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dii_calculator-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 08bb5517802ecb1d24137157da86d8b94b975798a12f9719b0a3b5c2fd4f9acc
MD5 39dd1927c5eea0a45a6b116beb571d8b
BLAKE2b-256 40a27d9586ec380b148a79c56071622f13223bdacc0a25e447f0767f1c5df6b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for dii_calculator-1.0.6-py3-none-any.whl:

Publisher: publish.yml on strathlab-data/DII

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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