Skip to content

localModel

0.5Package record

LIME-Based Explanations with Interpretable Inputs Based on Ceteris Paribus Profiles

0packages dependsuggested by 1
29.8Kdownloads / year
90.5%test coverage
12/13flavors OK

Overview

About

Local explanations of machine learning models describe, how features contributed to a single prediction. This package implements an explanation method based on LIME (Local Interpretable Model-agnostic Explanations, see Tulio Ribeiro, Singh, Guestrin (2016) doi:10.1145/2939672.2939778) in which interpretable inputs are created based on local rather than global behaviour of each original feature.

Changes in 0.5
  • predict_surrogate function is added to provide easier interface of accessing lime/iml/localModel implementations of the LIME method. (this function wes moved to DALEXtra)

From NEWS.md in the release

Install

Health

CRAN checks
1ERROR12OK
Check messages
ERRORtestsr-release-linux-x86_64
Running ‘testthat.R’ [9s/11s]
Running the tests in ‘tests/testthat.R’ failed.
Complete output:
  > library(testthat)
  > library(localModel)
  > library(DALEX)
  Welcome to DALEX (version: 2.5.4).
  Find examples and detailed introduction at: http://ema.drwhy.ai/
  Additional features will be available after installation of: ggpubr.
  Use 'install_dependencies()' to get all suggested dependencies
  > library(randomForest)
  randomForest 4.7-1.2
  Type rfNews() to see new features/changes/bug fixes.
  > 
  > test_check("localModel")
  Preparation of a new explainer is initiated
    -> model label       :  randomForest  ( [33m default [39m )
    -> data              :  500  rows  6  cols 
    -> target variable   :  not specified! ( [31m WARNING [39m )
    -> predict function  :  yhat.randomForest  will be used ( [33m default [39m )
    -> predicted values  :  No value for predict function target column. ( [33m default [39m )
    -> model_info        :  package randomForest , ver
...[truncated]...
 [39m ) 
    -> model_info        :  Model info detected classification task but 'y' is a NULL .  ( [31m WARNING [39m )
    -> model_info        :  By deafult classification tasks supports only numercical 'y' parameter. 
    -> model_info        :  Consider changing to numerical vector with 0 and 1 values.
    -> model_info        :  Otherwise I will not be able to calculate residuals or loss function.
    -> predicted values  :  numerical, min =  0.009202999 , mean =  0.464 , max =  0.9979422  
    -> residual function :  difference between y and yhat ( [33m default [39m )
   [32m A new explainer has been created! [39m 
  [ FAIL 1 | WARN 1 | SKIP 0 | PASS 19 ]
  
  ══ Failed tests ════════════════════════════════════════════════════════════════
  ── Failure ('test_generic.R:7:3'): Plots work with different geoms ─────────────
  Expected `{ ... }` to run silently.
  Actual noise: messages.
  
  [ FAIL 1 | WARN 1 | SKIP 0 | PASS 19 ]
  Error:
  ! Test failures.
  Execution halted

CRAN check page ↗

Slowest check: 2.4 min · r-oldrel-windows-x86_64
Status changes
  • ERROR12 OK, 1 ERROR2026-10-18
  • OK13 OK2026-09-09
  • ERROR12 OK, 1 ERROR2026-09-04
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
Show 7 earlier changesHide 7 earlier changes
  • OK13 OK2026-07-29
  • ERROR12 OK, 1 ERROR2026-07-25
  • OK13 OK2026-07-14
  • ERROR11 OK, 2 ERROR2026-07-11
  • OK13 OK2026-05-05
  • ERROR12 OK, 1 ERROR2026-05-01
  • OK14 OK2026-03-10
Advisories

none known

Documentation

In release 0.5
READMEYes · 156 wordsVignettesYes · 3 · dynamicNEWSYes · 100% structured · mentions 0.5Citation fileNo
Help pages
7includes a package overview page
Examples that run
100%5 run in a plain check
Exported functions with examples
75%
Documented parameters
100%
Return-value docs
100%
Help pages citing references
0%

Downloads

29.8K
CRAN downloads in the past year
Rank #2,819 · ~82/day · ~2.5K/mo
Daily download trend is not available in this view yet.
1.9K30 days
5.1K90 days
29.8K1 year
Compare downloads with other packages →
Also on77 r2u4 autocran

Repository

14Stars
3Forks
0Open issues
0Open PRs
2Releases
189Commits
5Commit identities
189 commits · Last activity 2021-09-19 · 0% stars, 30d
Responsiveness
How these are sampled
PRs merged (all time)
83%
Median days to close, 50 most recently updated closed issues
41
Median days to close, 50 most recently updated closed PRs
0

Stars over time

2023-03-19 · 142026-07-07 · 14
PracticesBeta

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

Checks run against github.com/modeloriented/localmodel on 2026-10-18.

Continuous integration (1)
Travis CI (config file)
Governance and community (1)
Contributing guide
Docs source (2)
pkgdown

GitHub Pages site last deployed 2021-09-19

Coverage (1)
Coverage reporting (Codecov)
Show all practicesHide 1 practice
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v3 (2026-09-26)

Dependencies

Declared dependencies
10 external dependencies (excludes base and recommended)

Installing localModel adds 43 packages (17 with compiled code, 34 MB of source tarballs). Heaviest: ggplot2 6.0 MB, glmnet 2.7 MB, ingredients 2.4 MB.

Depends (1)
R >= 3.5
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect
Suggested by 1
Suggests, most downloaded first

People & History

People (6)
Author, Maintainer since 0.5 (2021)
Contributor
Contributor
Contributor · added in 0.5
Contributor · added in 0.5

Previously maintained by Mateusz Staniak (0.3.11 to 0.3.12).

Releases (3)

Pick two releases to compare their code metrics.

  • R
    R 4.6.0 released · 2026-04-24
  • R
    R 4.5.0 released · 2025-04-11
  • R
    R 4.4.0 released · 2024-04-24
  • R
    R 4.3.0 released · 2023-04-21
  • R
    R 4.2.0 released · 2022-04-22
  • 0.5Latest
    record
    2021-09-14 · current release · diff ↗ ·
    added 1 export
    plot_interpretable_feature
  • R
    R 4.1.0 released · 2021-05-18
  • R
    R 4.0.0 released · 2020-04-24
  • 0.3.12
    record
    2019-12-18 · diff ↗
  • R
    R 3.6.0 released · 2019-04-26
  • 0.3.11
    record
    2019-04-14
  • R
    R 3.5.0 released · 2018-04-23

Package metadata

First published
2019-04-14
Total releases
3 / 7 yrs
License
GPL
Minimum R
≥ 3.5
Download size
72 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("localModel")
Biecek, P., Gosiewska, A., Igras, K., Lustiger, H., Staniak, M., & Tadema, W. (2021). localModel: LIME-Based Explanations with Interpretable Inputs Based on Ceteris Paribus Profiles (Version 0.5) [Computer software]. https://doi.org/10.32614/CRAN.package.localModel

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

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 localModel version 0.5 [Data set]. HJJB, LLC. Data release v2026-10-20. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-20, 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