civ

0.1.0

Categorical Instrumental Variables

0packages depend

2.2Kdownloads / year

100.0%test coverage

11/13checks pass

Overview

About

Maintained by Thomas WiemannFirst published 2023-12-081 releasesCRAN page ↗GitHub ↗

Implementation of the categorical instrumental variable (CIV) estimator proposed by Wiemann (2023) arXiv:2311.17021. CIV allows for optimal instrumental variable estimation in settings with relatively few observations per category. To obtain valid inference in these challenging settings, CIV leverages a regularization assumption that implies existence of a latent categorical variable with fixed finite support achieving the same first stage fit as the observed instrument.

Install

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

install.packages("civ", 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("thomaswiemann/civ")

Development version from thomaswiemann/civ. 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-civ

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-civ

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-civ

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

Health

CRAN checks

2NOTE11OK

Failing flavors

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

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

Code health

Yes

Tests · ratio 0.55

100.0%

Coverage · measured lines

100%

Documentation · exports

Dependencies · direct

Check history

NOTE2026-06-09
11 OK · 2 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-06-08
11 OK · 1 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
NOTE2026-03-10
12 OK · 2 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 941 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

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

Downloads

2.2K

CRAN downloads in the past year

Rank #21,043 · ~6/day · ~180/mo

Releases R versions

Daily download trend is not available in this view yet.

19830 days

57690 days

2.2K1 year

Compare downloads with other packages →

Also on102 r2u9 autocran

Repository

GitHub ↗ thomaswiemann/civ

3Stars

0Forks

1Open issues

0Open PRs

1Releases

31Commits

1Contributors

License GPL-3.0 · 31 commits · Last activity 2024-03-03 · 0% stars, 30d

Stars over time

2024-10-29 · 22026-07-07 · 3

Repository practices

Upstream repositoryBeta

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

Checks run against github.com/thomaswiemann/civ on 2026-07-19.

Continuous integration (1)

GitHub Actions

Reproducibility and dev environment (1)

Nix

CRAN release process (1)

cran-comments.md

Docs source (1)

README.Rmd

Show all practices

Lint, format, editor (1)

RStudio project

Coverage (1)

Codecov

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

Dependencies

Declared dependencies

6 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.6

Imports (3)

statsAER kcmeans

LinkingTo (0)

none

Suggests (4)

testthat covr knitr rmarkdown

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Code Composition

R 171 (47%)Rd 103 (28%)Vignettes 91 (25%)

Code characteristics

Object systems

S31

Cyclomatic complexity: 1.5 median / 2 max
Test cases: 2 / 0.55 per code line

Test coverage

Line coverage

100%

Expression

100.0%

Tests / Examples

100.0% / 93% ex

Functions

2 1 exported

Complexity

1.5 avg / 2 max

Call network

2 nodes / 0 edges

Call graph

Open call graph →

Loading call graph…

Lowest coverage

2 functions

Function	Cyclo	Coverage
civ exp	2	100%
summary.civ	1	100%

People & History

People (1)

Maintainer (1)

Thomas Wiemann

Author, Maintainer

Authors (1)

Thomas Wiemann

Author, Maintainer

Package Timeline

1 release. R releases are shown for context.

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

Package metadata

First published: 2023-12-08
Total releases: 1 / 3 yrs
License: GPL (>= 3) OSI
Minimum R: ≥ 3.6
Download size: 33 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →