Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

465 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

R-MORIE rmorie hex logo

Status Lifecycle r-universe CI Coverage AGPL-3.0

R-MORIE (Multi-domain Open Research and Inferential Estimation) is an R package for causal inference, sampling, psychometrics, point-process modeling, and criminological accountability analysis, with no Python dependencies.

Statement of need

Applied observational research on Canadian carceral, policing, and oversight data usually means stitching together a dozen single-purpose packages — one for difference-in-differences, one for propensity-score matching, one for spatial scan statistics, one for self-exciting point processes — each with its own data contract, and none aware of the survey-weighting, provenance, and privacy constraints these data carry. rmorie is for criminologists, quantitative social scientists, and accountability researchers who need those estimators in one consistent, provenance-preserving toolkit, with the MRM (Multilevel Reconciliation Methodology) framework as its motivating application. Every public function is prefixed morie_* so it composes safely alongside the specialist packages it wraps, and results carry the labeling that keeps synthetic development runs from being mistaken for inferential findings. Primary methodological references for each estimator family are listed in the package-level help (?rmorie).

Documentation

With over 2,000 exported functions, the full reference is large — use the manual or the package site above rather than scrolling the function index. This README covers install + the most common workflows only.

Why rmorie?

rmorie is a self-contained research toolkit: every statistical algorithm in the package — matching (nearest-neighbour, Mahalanobis, exact, CEM, optimal, genetic, cardinality), design-based IPW and doubly-robust estimation, double machine learning, causal forests and meta-learners, causal DAGs with identification and refutation, the full quasi-experimental family (DiD incl. Callaway-Sant'Anna, event studies, synthetic control and synthetic DiD, RDD, interrupted time series, IV), item-response theory, geostatistics, digital signal processing, Hawkes processes, cryptographic hashing with post-quantum primitives, and the data-access parsers — is implemented natively in this package's R and C++. rmorie does not call MatchIt, survey, DoubleML, grf, dagitty, did, fixest, rdrobust, ivreg, psych, gstat, spdep, signal, wavelets, digest, or openssl at runtime. This means:

  • No upstream breakage. A major release of any of those packages cannot change rmorie's results. A paper run in 2026 reproduces identically in 2030.
  • Validated, not just reimplemented. Every native engine is cross-validated in tests/cross/ against its reference package — to machine precision where the estimand is deterministic (see the table below) — and benchmarked in inst/benchmarks/.
  • Composable workflows. Matchers, ATE/CATE/DiD estimators, and the DAG pipeline share one class system with common print(), summary(), and reporting methods; the phase-17 composition test runs DAG -> identification -> matching -> DML -> refutation -> publication table end to end in one suite.
  • Category-integrity guards. morie_safe_recode(), morie_safe_factor(), morie_audit_categories(), and morie_crosstab_verify() make the silent category-mapping errors that have corrupted published disparity analyses structurally impossible in an rmorie workflow.

The remaining Suggests entries exist ONLY for the cross-validation tests under tests/cross/ and as optional accelerators for the parsers (jsonlite/xml2/arrow fast paths with pure-R fallbacks); no production statistics path requires any of them.

Cross-validation at a glance

Family Replaces Validation
Matching (7 methods) MatchIt, optmatch, Matching, designmatch pair-identical or provably better optimum
IPW / design-based GLM survey svyglm coefficients + SEs to 1e-6
DML (PLR + IRM) DoubleML/mlr3 CI-overlap agreement; 40-60x faster
Causal forest / meta-learners grf CATE agreement; 1.5-2.9x faster
DAG identify/estimate/refute dagitty, DoWhy adjustment sets == dagitty on every graph tested
DiD family (TWFE/event/CS/DR/Bacon/DID-M/feTR) fixest, did, DRDID, bacondecomp, DIDmultiplegt, TwoWayFEWeights coefficients, SEs, and influence functions to 1e-8-1e-10
Synth control + SDID Synth/coresynth recovers simulated truths; placebo inference built in
RDD (IK bw, sharp/fuzzy/kink, McCrary) rdrobust, rdd point estimates == rdrobust at fixed h to 1e-8
IV (2SLS/LIML/GMM) + ITS AER, ivreg, gmm 2SLS == ivreg + sandwich HC1 to 1e-8
IRT (2PL/GRM/EAP) + psychometrics psych, mirt KMO == psych to 1e-8; 2PL vs mirt within 0.1
Geostatistics (variogram/kriging) gstat, spdep kriging == gstat to 1e-6; Moran variance == spdep
DSP (Butterworth/FIR/Welch/DWT) signal, wavelets butter coefficients == signal to 1e-8; DWT perfect reconstruction
Hawkes MLE hawkes exponential-kernel loglik == hawkes
SHA-256/HMAC/PBKDF2 + PQC digest, openssl NIST FIPS + RFC vectors bit-for-bit; ML-KEM/ML-DSA/SLH-DSA/HQC via liboqs
Parsers (JSON/XML/HTML/Parquet) jsonlite, xml2, arrow jsonlite-parity outputs; accelerators optional
Weighting family (ps/entropy/CBPS/OW/stabilized/SuperLearner) WeightIt, CBPS glm weights == WeightIt to 1e-8; CBPS moments < 1e-6
Modern staggered DiD (Sun-Abraham/Borusyak/did2s) did2s, didimputation point estimates within 0.02 of did2s
Unified front-ends (morie_did/morie_iv_2sls/morie_rdd) did, AER, rdrobust CS overall == did::aggte to 0.1; 2SLS == ivreg to 1e-6
Crim methods (ETAS/multivariate Hawkes/Knox/RTM) (papers) recovers simulated truths; Knox permutation calibrated

What rmorie is NOT

rmorie is not a wrapper. At runtime it does not call:

  • MatchIt / optmatch / Matching / designmatch (matching) — replaced by morie_matching_*
  • WeightIt / CBPS (propensity weighting) — replaced by morie_weight_*
  • survey (design-based estimation) — replaced by the native svyglm engine behind morie_ipw_* / morie_ebac_*
  • DoubleML / mlr3 (double machine learning) — replaced by the native PLR/IRM/PLIV cross-fit engines
  • grf / EconML-style learners (heterogeneous effects) — replaced by the native causal forest and T/S/X/DR meta-learners
  • dagitty / DoWhy (DAGs, identification, refutation) — replaced by morie_dag_*
  • did / fixest / did2s / didimputation (modern DiD) — replaced by morie_did_* with auto-dispatch to Callaway-Sant'Anna, Sun-Abraham, Borusyak, and Gardner two-stage
  • rdrobust (RDD) — replaced by morie_rdd (IK bandwidth + McCrary + placebo cutoffs bundled)
  • Synth (synthetic control) — replaced by morie_synth_control with built-in placebo inference
  • AER / ivreg (IV) — replaced by morie_iv_2sls with the Staiger-Stock refusal gate
  • psych / mirt (psychometrics) — replaced by morie_psymet_* and morie_irt_*
  • gstat / spdep (geostatistics) — replaced by the native variogram/kriging/GWR stack
  • signal / wavelets (DSP) — replaced by rgfir/rgiir/rgwav and morie_dsp_*
  • hawkes (point processes) — replaced by the native C++ Hawkes kernel family + morie_crim_etas / morie_crim_hawkes_multivariate
  • digest / openssl (hashing/KDF) — replaced by the native C++ SHA-2/HMAC/PBKDF2 + liboqs PQC
  • jsonlite / xml2 / arrow as requirements (parsing) — replaced by morie_fetch_* pure-R parsers (those packages remain optional fast paths only)

Those packages appear in Suggests solely so tests/cross/ can prove, on every CI run, that the native engines match them.

What's in v1.1.4

  • All 25 native-specialization modules complete — see Why rmorie? above; the package's statistics run with zero runtime dependencies on other statistical packages.
  • Over 2,000 exported morie_* R functions — every public callable is now prefixed to avoid name collisions with other CRAN packages (morie_chi_square_test, morie_kmeans_clustering, morie_decision_tree_split, etc.). The companion morie.fn Python library mirrors these for cross-language parity. Two deliberate exceptions keep their unprefixed names to match the MRM papers and the Python implementation exactly: mrm_otis_mandela_spectrum() and mrm_classify_mandela().
  • SIU subsystem — a full pipeline for the Ontario Special Investigations Unit director's-report corpus (English + French, 2005-present). See SIU pipeline below.
  • Free-first AI helpers — local Ollama by default (gemma3:4b, translategemma:latest), with optional Gemini, Claude, or Vertex AI fallback. No paid API key is required for the default workflow.
  • Polite-by-default HTTP fetcher — token-bucket throttling at 4 req/s, exponential backoff on 429/5xx, on-disk page cache.
  • Built-in datasets — 41 datasets accessible through the shared SQLite store (morie_datasets.db), plus the SIU manifest (4,743 drids, 2,218 unique cases, language-classified).
  • CPADS contract helpers and IPW / eBAC workflow functions.
  • Outputs-manifest tooling — read, validate, audit, and build outputs_manifest.csv tables for reproducible research projects.
  • Synthetic data generators for development and CI.
  • C/C++ computational backend — Hawkes self-exciting point process likelihood (Markovian + non-Markovian), HTML-to-text state machine, SIU parser. See src/.
  • Causal-taphonomy suite — Bayesian hierarchical preservation model (cmdstanr / brms / rstanarm HMC backends), absorbing-DTMC decay chains, forensic likelihood ratios, pXRF compositional transforms, and USGS NGDB / MorphoSource open-data ingest.
  • agent() — call the rmorie CLI agent from R (with agent_available() to probe for the binary).

Scientific guardrail

  • Synthetic data is for development, testing, demos, and CI only.
  • Final inferential or policy-facing results must be produced from approved real data with full provenance.
  • Synthetic runs must be explicitly labeled as synthetic in outputs and reporting text.

Install

From local source:

install.packages("r-package/morie", repos = NULL, type = "source")

From r-universe (development snapshot):

install.packages(
  "rmorie",
  repos = c(rootcoder007 = "https://rootcoder007.r-universe.dev",
            CRAN         = "https://cloud.r-project.org")
)

# want every optional package too, in one shot? add dependencies = TRUE
# (large: compiles many specialist packages — see "Optional packages" below)
install.packages(
  "rmorie", dependencies = TRUE,
  repos = c(rootcoder007 = "https://rootcoder007.r-universe.dev",
            CRAN         = "https://cloud.r-project.org")
)

The assistant bridge supports a local fallback through the Python package when no live OpenAI / Anthropic credentials are configured.

Optional packages (the R equivalent of pip install pkg[extra])

The base install is complete for every statistical workflow — the native engines need nothing beyond the hard dependencies. Suggests entries are (a) reference packages used only by the cross-validation tests in tests/cross/, and (b) optional accelerators (e.g. jsonlite/xml2/arrow fast paths for the parsers, ML backends). Every optional-path function tells you what to install when it's missing, and the test suite skips (never fails) without them. To provision the extras up front:

# install every optional package rmorie can use (one-time, ~15 min)
morie_install_extras(which = "all", ask = FALSE)

# or just what's missing, interactively
morie_install_extras()

# or a specific family, e.g. machine learning
morie_install_extras(which = c("randomForest", "glmnet", "xgboost",
                               "ranger", "caret", "pROC"))

Common families: ML (randomForest, glmnet, xgboost/gbm, ranger, caret, pROC, Rtsne, e1071, dbscan), DSP (signal, pracma, wavelets), causal (DoubleML, mlr3, mlr3learners, ivreg, fixest), storage (RSQLite, duckdb).

Outputs-manifest example

library(rmorie)

manifest <- morie_read_outputs_manifest(project_root = "/path/to/project")
audit    <- morie_audit_public_outputs(project_root = "/path/to/project",
                                       manifest     = manifest)
morie_summarize_output_audit(audit)

Synthetic data example

library(rmorie)

synthetic_path <- morie_write_synthetic_data(
  path      = "data/private/synthetic_study_data.csv",
  n         = 8000,
  seed      = 2026,
  overwrite = TRUE
)

Cross-project adaptation

library(rmorie)

name_map <- morie_default_synthetic_name_map("generic")
name_map["cannabis_use"] <- "exposure_any"
name_map["bac"]          <- "outcome_continuous"

dat <- morie_generate_synthetic_data(
  n        = 5000,
  seed     = 1,
  name_map = name_map
)

SIU pipeline

rmorie ships the first open-source parser and data-mining subsystem for the Ontario Special Investigations Unit (SIU) director's-report corpus — created by Vansh Singh Ruhela as part of the MORIE / R-MORIE ecosystem and the MRM (Multilevel Reconciliation Methodology) framework. To our knowledge no prior public, open-source SIU director's-report parser or automated SIU data-mining engine existed in Canada; the SIU publishes the reports, but there was no programmatic pipeline to fetch, parse, and analyse them at corpus scale until this one.

A first-class subsystem for the Ontario Special Investigations Unit director's-report corpus. The fetcher handles both English and French templates from 2005 onward across all three of the site's historical layout generations (pre-2017 Attorney-General releases, the 2017-2019 transitional format, and the post-2019 SIU Act template); the parser extracts the report fields (police service, incident/notification/ decision dates, investigator and witness/subject-official counts, affected-person demographics, injuries, legislation, charges verdict, and director's decision) and is hand-rolled for correctness under SIU's heterogeneous markup.

Since 1.1.4 the subsystem is layered on the compiled SIU core in 'rmoriebricklayer' and the verified corpus shipped by 'rmoriedata': a 65-column table of 5,157 reports whose 2,182 English entries were read and cross-audited by a multi-agent review panel (every subject-official count verified; the mechanical resolver scores zero wrong against it). morie_siu_reports() returns that corpus verbatim and only ever fetches/parses reports newer than it; morie_siu_resolve_so() answers from the verified corpus first and falls back to the compiled rule engine; morie_siu_panel() runs the same Mixture-of-Agents reading panel on new reports through any Ollama-compatible endpoint you point it at (your models, your host — no hardcoded default).

The subsystem powers downstream MRM analyses — Hawkes self-exciting point processes, causal estimators, fairness audits, and the physics- of-crime modules — on Canadian police-oversight data.

Key entry points: morie_siu_reports(), morie_siu_resolve_so(), morie_siu_panel(), morie_siu_parse_report(), plus the legacy fetch path morie_fetch_siu(), morie_siu_index_url(), morie_siu_refresh_manifest(), morie_siu_audit_case(), morie_siu_sanity_check(), morie_siu_all_analyses().

Fetch and parse the full corpus

library(rmorie)

# Prefer the panel-verified corpus (5,157 reports x 65 columns,
# 2,182 English entries human+multi-agent reviewed) — no re-fetching:
df <- morie_siu_reports(update = FALSE)

# The legacy live fetch remains available:
# df <- morie_fetch_siu(lang = "en", cache_html = TRUE, rate_limit = 4)
nrow(df)

Audit a single case

# Inspect parser row + raw HTML + cleaned text side-by-side.
morie_siu_audit_case("16-OFI-019")

# Per-field "does the HTML actually support this value?" check.
morie_siu_anomaly_check("16-OFI-019")

# Diff parser output against an external table.
morie_siu_compare(
  case_number = "16-OFI-019",
  external    = my_other_table,
  field_map   = c(officer_count = "n_officers")
)

AI extraction (free local model by default)

# Default: local Ollama with gemma3:4b. No API key required.
morie_siu_llm_extract("16-OFI-019")

# Failover chain: try local first, fall back to Gemini only on error.
morie_siu_llm_extract("16-OFI-019", model = c("ollama", "gemini"))

# French to English translation via translategemma.
morie_siu_translate(text = "L'enquete a ete close...", target_lang = "en")

Supported providers: ollama (default), gemini, claude, vertex. Environment knobs: OLLAMA_HOST (defaults to http://localhost:11434), OLLAMA_MODEL (defaults to gemma3:4b), OLLAMA_KEEP_ALIVE (30m).

Format-validity sweep

sane <- morie_siu_sanity_check(df)
sum(!sane$ok)  # rows with format issues (regex / ISO date / Yes-No / chrome leak)

Aggregate accuracy

# How accurate is each column across a sample of cases?
morie_siu_audit_columns(case_numbers = sample(df$case_number, 50))

Canonical override system

The parser learns. Ship-time corrections live in inst/extdata/siu_canonical_overrides.csv.gz (47 hand-verified corrections covering 10 spot-checked cases). Users can add their own:

morie_siu_record_correction(
  case_number = "20-OFD-082",
  field       = "officer_count",
  value       = 3L
)

Overrides are applied automatically at the end of morie_fetch_siu(), per cell, by case number.

Inspect the manifest

manifest <- morie_siu_index()
table(manifest$`_language`)  # en=2531, fr=2212, unknown=0

Continuous integration

The R CMD check matrix covers six cells, all green on main:

Platform R version
macos-latest release
windows-2025 release
ubuntu-latest release
ubuntu-latest release + postgres-15
ubuntu-latest oldrel-1
ubuntu-latest devel

Plus: pkgcheck, covr + Codecov upload, lintr, goodpractice, and CodeQL.

Citation

If you use rmorie in your research, please cite the software:

Ruhela, V. S. (2026). rmorie: Multi-domain Open Research and Inferential Estimation in R. https://github.com/rootcoder007/rmorie

BibTeX (or run citation("rmorie") after installation for the entry stamped with the exact installed version, sourced from inst/CITATION):

@Manual{ruhela_rmorie_2026,
  title   = {rmorie: Multi-domain Open Research and Inferential Estimation in R},
  author  = {Ruhela, Vansh Singh},
  year    = {2026},
  url     = {https://github.com/rootcoder007/rmorie}
}

See CITATION.cff for the machine-readable metadata GitHub's "Cite this repository" button uses.

License

R-MORIE is licensed under AGPL-3.0-or-later. See LICENSE for the full text and LICENSING.md for the per-component breakdown.

Bayesian priors

rmorie's Bayesian regression (morie_bayes_lm) places zero-mean Normal priors on the regression coefficients; the prior_sd argument is the prior standard deviation (the scale of plausible coefficient values). Larger prior_sd is weakly informative; smaller values pull estimates toward zero (regularisation). Example:

d <- data.frame(x = rnorm(100)); d$y <- 1 + 2 * d$x + rnorm(100)
# weakly-informative prior (sd = 10) vs a tight regularising prior (sd = 0.5)
fit_weak  <- morie_bayes_lm(y ~ x, d, prior_sd = 10)
fit_tight <- morie_bayes_lm(y ~ x, d, prior_sd = 0.5)

See the bayesian-priors vignette for applied guidance.

Releases

Packages

Used by

Contributors

Languages