Skip to main content

Local polynomial methods for boundary discontinuity designs

Project description

rd2d for Python

rd2d provides local polynomial estimation, robust bias-corrected inference, and bandwidth helpers for boundary discontinuity designs with bivariate running variables. The package includes location-based and distance-based methods, sharp and fuzzy designs, pointwise confidence intervals, covariance-backed summary inference, uniform confidence bands, and aggregate boundary effect summaries.

from rd2d import rd2d, rdbw2d, rd2d_dist, rdbw2d_dist, summary

Main Functions

  • rd2d(): location-based estimation and inference.
  • rdbw2d(): location-based bandwidth selection.
  • rd2d_dist() and rd2d_distance(): distance-based estimation and inference.
  • rdbw2d_dist() and rdbw2d_distance(): distance-based bandwidth selection.
  • summary(): summary tables with optional uniform bands, WBATE, and LBATE.

The sibling scripts ../rd2d_illustration.py and ../rd2d_plot.py provide a self-contained simulation, estimation, and plotting workflow. Generated files are written under ../output/.

Installation

python -m pip install rd2d

For local development:

python -m pip install -e .

Optional plotting and testing dependencies can be installed with:

python -m pip install -e ".[plots,test]"

Basic Usage

import numpy as np
from rd2d import rd2d

rng = np.random.default_rng(123)
n = 800
x1 = rng.normal(size=n)
x2 = rng.normal(size=n)
assignment = (x1 >= 0).astype(float)
y = 3 + 2 * x1 + 1.5 * x2 + assignment + rng.normal(size=n)
x = np.column_stack([x1, x2])
b = np.array([[0.0, 0.0], [0.0, 1.0]])

fit = rd2d(y, x, assignment, b, h=0.9, params_cov="main")
fit.main
fit.summary(cbands="main").tables["main"]

For distance-based designs, pass one signed-distance column per evaluation point. Nonnegative distances identify observations on the treated side.

from rd2d import rd2d_dist

distance = x1.reshape(-1, 1)
fit_dist = rd2d_dist(y, distance, h=0.5, b=np.array([[0.0, 0.0]]))
fit_dist.main

Development

From this directory:

python -m pytest

Publishing From GitHub

The workflow .github/workflows/python-publish.yml builds, checks, tests, and publishes the Python package to PyPI with trusted publishing. Configure:

  • PyPI project: rd2d.
  • Trusted publisher owner: rdpackages.
  • Trusted publisher repository: rd2d.
  • Trusted publisher workflow: python-publish.yml.
  • Trusted publisher environment: pypi.

In GitHub, create an environment named pypi. Add required reviewers there if you want each PyPI upload to require manual approval. Publish by creating a GitHub Release or by running the Publish Python package workflow manually.

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

rd2d-0.1.0.tar.gz (27.4 kB view details)

Uploaded Source

Built Distribution

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

rd2d-0.1.0-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file rd2d-0.1.0.tar.gz.

File metadata

  • Download URL: rd2d-0.1.0.tar.gz
  • Upload date:
  • Size: 27.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rd2d-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6f5054e25f25bf167dcc81a0e3000d766cca25b9106d2a24552efec5c6394d19
MD5 6f4ea79ba3de435b461d07192cdbcfe2
BLAKE2b-256 9c655127a272dfc68a446e597df98f7f815d99e043a99357ab9d64377b4f3952

See more details on using hashes here.

Provenance

The following attestation bundles were made for rd2d-0.1.0.tar.gz:

Publisher: python-publish.yml on rdpackages/rd2d

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

File details

Details for the file rd2d-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rd2d-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rd2d-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 869bbad3a02c60a387571d210812670e9b2cc715d860f018d1955906d6d62ffa
MD5 eeacb650c5024f3aab998eb3cd65e6cd
BLAKE2b-256 24ff834edae060886c29b79677ad7d73a756cde0365956f8ec8756209bb3a25b

See more details on using hashes here.

Provenance

The following attestation bundles were made for rd2d-0.1.0-py3-none-any.whl:

Publisher: python-publish.yml on rdpackages/rd2d

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