Skip to content

ivcheck

0.1.2Package record

Tests for Instrumental Variable Validity

0packages depend
2.2Kdownloads / year
85.2%test coverage
13/13flavors OK

Overview

About

Implements tests for the identifying assumptions of instrumental variable models, the local exclusion restriction and monotonicity conditions required for local average treatment effect identification. Covers Kitagawa (2015) doi:10.3982/ECTA11974, Mourifie and Wan (2017) doi:10.1162/REST_a_00622, and Frandsen, Lefgren, and Leslie (2023) doi:10.1257/aer.20201860. Includes a one-shot wrapper that runs all applicable tests on a fitted instrumental variable model. Dispatches on 'fixest' and 'ivreg' model objects.

Changes in 0.1.2

Bug fix (behaviour change)

  • iv_kitagawa() dispatched on a fitted fixest or ivreg model with exogenous controls used to silently drop the controls and return the unconditional test. This was wrong when validity is only conditional on X. The fitted-model methods now error and direct the user to iv_mw() for the conditional Mourifie-Wan (2017) test, or to the raw-vector default method to force an unconditional test on the same data.
  • iv_check() now filters its applicable-tests list by the presence and dimensionality of exogenous controls. Kitagawa is dropped when any control is present; Mourifie-Wan is dropped when more than one control is present (multivariate X is planned for v0.2.0 via a tensor-product series basis). When a test is dropped, iv_check() emits an informational message explaining why.
Show all changes in 0.1.2Hide the rest of the changes in 0.1.2
  • iv_check() no longer falls back to running Mourifie-Wan unconditionally when handed a model with multivariate controls. That downgrade was the same silent-drop bug as the Kitagawa one.

Documentation

  • vignette("with-fixest") rewritten to demonstrate the new behaviour: the unconditional case, the single-control conditional path through iv_mw(), and the multivariate workaround (propensity-index dimension reduction).

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 2.3 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK6 OK2026-04-23
Advisories

none known

Documentation

In release 0.1.2
READMEYes · 2,741 wordsVignettesYes · 3 · dynamicNEWSYes · 100% structured · mentions 0.1.2Citation fileYes · cites a publicationWebsiteYes · pkgdown
Help pages
12 (1 internal)includes a package overview page
Examples that run
17%1 run in a plain check · 5 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples
100%
Documented parameters
93%
Return-value docs
100%
Help pages citing references
33%

Downloads

2.2K
CRAN downloads in the past year
Rank #12,513 · ~6/day · ~185/mo
Daily download trend is not available in this view yet.
29730 days
89390 days
2.2K1 year
Compare downloads with other packages →
Also on44 r2u4 autocran

Repository

3Stars
1Forks
0Open issues
0Open PRs
0Releases
63Commits
1Commit identities
63 commits · Last activity 2026-09-19 · +50% stars, 30d
Responsiveness
not measured

Stars over time

2026-07-14 · 22026-10-21 · 3
PracticesBeta

8 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/charlescoverdale/ivcheck on 2026-10-21.

Continuous integration (1)
GitHub Actions
Docs source (3)
pkgdown

GitHub Pages site last deployed 2026-09-19 · The repository has a site deploy workflow

pkgdown site last built 2026-09-19

Reproducibility and dev environment (1)
data-raw/
CRAN release process (2)
cran-comments.mdCRAN-SUBMISSION
Show all practicesHide 1 practice
For agents and models (1)
llms.txt
How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies
9 external dependencies (excludes base and recommended)

Installing ivcheck adds 1 package (1 with compiled code, 629 KB of source tarballs). Heaviest: cli 629 KB.

Depends (1)
R >= 4.1.0
Imports (3)
clistatsparallel
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

Datasets

People & History

People (1)
Author, Maintainer since 0.1.1 (2026)
Releases (2)

Pick two releases to compare their code metrics.

  • 0.1.2Latest
    record
    2026-05-30 · current release · diff ↗
  • R
    R 4.6.0 released · 2026-04-24
  • 0.1.1
    record
    2026-04-22
  • R
    R 4.5.0 released · 2025-04-11

Package metadata

First published
2026-04-22
Total releases
2 / 1 yrs
License
MIT + file LICENSE OSI
Minimum R
≥ 4.1.0
Bundled data
15 KB / 1 file
Download size
173 KB

Cite

Cite this package

Run in R for the authors' entry:

citation("ivcheck")

The package provides a citation file, so citation() returns the authors' own entry.

It points to 10.3982/ecta11974, 10.1162/rest_a_00622, 10.1257/aer.20201860, 10.2307/2951620.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for ivcheck version 0.1.2 [Data set]. HJJB, LLC. Data release v2026-10-23. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy