budgetIVr

0.1.2

Partial Identification of Causal Effects with Mostly Invalid Instruments

0packages depend

2.5Kdownloads / year

–test coverage

12/13checks pass

Overview

About

Maintained by Jordan PennFirst published 2025-04-161 releasesCRAN page ↗GitHub ↗

A tuneable and interpretable method for relaxing the instrumental variables (IV) assumptions to infer treatment effects in the presence of unobserved confounding. For a treatment-associated covariate to be a valid IV, it must be (a) unconfounded with the outcome and (b) have a causal effect on the outcome that is exclusively mediated by the exposure. There is no general test of the validity of these IV assumptions for any particular pre-treatment covariate. However, if different pre-treatment covariates give differing causal effect estimates when treated as IVs, then we know at least some of the covariates violate these assumptions. 'budgetIVr' exploits this fact by taking as input a minimum budget of pre-treatment covariates assumed to be valid IVs and idenfiying the set of causal effects that are consistent with the user's data and budget assumption. The following generalizations of this principle can be used in this package: (1) a vector of multiple budgets can be assigned alongside corresponding thresholds that model degrees of IV invalidity; (2) budgets and thresholds can be chosen using specialist knowledge or varied in a principled sensitivity analysis; (3) treatment effects can be nonlinear and/or depend on multiple exposures (at a computational cost). The methods in this package require only summary statistics. Confidence sets are constructed under the "no measurement error" (NOME) assumption from the Mendelian randomization literature. For further methodological details, please refer to Penn et al. (2024) doi:10.48550/arXiv.2411.06913.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("budgetIVr", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("jpenn2023/budgetIVr")

Development version from jpenn2023/budgetIVr. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-budgetivr

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-budgetIVr

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-budgetIVr

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

1NOTE12OK

Failing flavors

NOTE r-devel-linux-x86_64-debian-gcc

Slowest check: 1.1 min · r-oldrel-windows-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

Dependencies · direct

Check history

NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 521 wordsVignettesNopkgdown siteNoNEWSNoCode of conductNoContributing guideNo

Examples that run: 100%
Documented parameters: 100%
Return-value docs: 100%
References docs: 100%

Downloads

2.5K

CRAN downloads in the past year

Rank #19,825 · ~7/day · ~205/mo

Releases R versions

Daily download trend is not available in this view yet.

18030 days

55890 days

2.5K1 year

Compare downloads with other packages →

Also on112 r2u2 autocran

Repository

GitHub ↗ jpenn2023/budgetivr

1Stars

1Forks

0Open issues

1Open PRs

0Releases

67Commits

3Contributors

67 commits · Last activity 2025-04-07 · 0% stars, 30d

Stars over time

2025-09-30 · 12026-07-07 · 1

Repository practices

Upstream repositoryBeta

1 development-tooling and community-health practice detected across 1 family in the upstream repository

Checks run against github.com/jpenn2023/budgetivr on 2026-08-02.

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

3 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.5.0

Imports (5)

data.table arrangementsMASSRglpkstats

LinkingTo (0)

none

Suggests (0)

none

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (1)

Maintainer (1)

Jordan Penn

Author, Maintainer, Copyright holder

Authors (1)

Jordan Penn

Author, Maintainer, Copyright holder

Jordan Penn

Author, Maintainer, Copyright holder

Package Timeline

1 release. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
0.1.2Latest
2026-03-10 · current release
R
R 4.5.0 released · 2025-04-11

Package metadata

First published: 2025-04-16
Total releases: 1 / 1 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 3.5.0
Bundled data: 7.7 KB / 2 files
Download size: 77 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →