DHARMa

Diagnostics for HierArchical Regession Models

https://github.com/florianhartig/dharma

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    11 of 26 committers (42.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary

Keywords

cran glmm regression regression-diagnostics residual

Keywords from Contributors

ecological-models mcmc bayes smc systems-biology ecology visualisation bayesian-inference
Last synced: 6 months ago · JSON representation

Repository

Diagnostics for HierArchical Regession Models

Basic Info
Statistics
  • Stars: 239
  • Watchers: 12
  • Forks: 23
  • Open Issues: 123
  • Releases: 46
Topics
cran glmm regression regression-diagnostics residual
Created about 11 years ago · Last pushed 6 months ago
Metadata Files
Readme

README.md

Project Status: Active – The project has reached a stable, usable state and is being actively developed. License: AGPL v3 CRAN_Status_Badge minimal R version

DHARMa - Residual Diagnostics for HierARchical Models

The 'DHARMa' package uses a simulation-based approach to create readily interpretable scaled (quantile) residuals for fitted generalized linear (mixed) models. Currently supported are linear and generalized linear (mixed) models from 'lme4' (classes 'lmerMod', 'glmerMod'), 'glmmTMB', 'GLMMadaptive' and 'spaMM'; phylogenetic linear models from 'phylolm' (classes 'phylolm' and 'phyloglm'); generalized additive models ('gam' from 'mgcv'); 'glm' (including 'negbin' from 'MASS', but excluding quasi-distributions) and 'lm' model classes. Moreover, externally created simulations, e.g. posterior predictive simulations from Bayesian software such as 'JAGS', 'STAN', or 'BUGS' can be processed as well. The resulting residuals are standardized to values between 0 and 1 and can be interpreted as intuitively as residuals from a linear regression. The package also provides a number of plot and test functions for typical model misspecification problems, such as over/underdispersion, zero-inflation, and residual spatial, temporal and phylogenetic autocorrelation.

Installing DHARMa

From CRAN

DHARMa is on CRAN, and for most users, installing from CRAN will be the best option. To install the latest CRAN release, just run

{r} install.packages("DHARMa")

To get an overview about its functionality once the package is installed, run

{r} library(DHARMa) ?DHARMa vignette("DHARMa", package="DHARMa") The vignette, which can also be read online here, provides many exampless about how to use the package function for the supported regression models. To cite the package, run

{r} citation("DHARMa")

To fit a model (from any package supported by DHARMa), run

```{r} testData = createData(sampleSize = 200, family = poisson()) m1 <- glm(observedResponse ~ Environment1, family = "poisson", data = testData)

res <- simulateResiduals(m1, plot = T) ```

and read to help of ?simulateResiduals and the vignette to understand what you can do with the object res. If you want to ask questions about DHARMa, or report a bug, please use the DHARMa GitHub issue page.

Development release

New features in DHARMa will typically on GitHub 1-2 months before they are on CRAN. If you want to install the current (development) version from this repository, run

{r} devtools::install_github(repo = "florianhartig/DHARMa", subdir = "DHARMa", dependencies = T, build_vignettes = T) Below the status of the automatic tests via GitHub Actions

R-CMD-check.yaml

Development branches / older releases

To install a specific (older) release, or a particular branch, decide for the version number that you want to install in https://github.com/florianhartig/DHARMa/releases (version numbering corresponds to CRAN, but there may be smaller releases that were not pushed to CRAN), or branch and run

{r} devtools::install_github(repo = "florianhartig/DHARMa", subdir = "DHARMa", ref = "v0.0.2.1", dependencies = T, build_vignettes = T) with the appropriate version number / branch as argument to ref.

Contributing to DHARMa

Contributions to DHARMa are very welcome! There are several ways in which you can contribute:

  • A simple but nevertheless important way to contribute is to suggest problems / new features in DHARMa, and post them in our issue tracker. A good issue should at least have a clear reproducible example. If possible, it could also already contain an analysis of the problem, and / or ideas for a fix. Likewise, feel free to comment on issues existing issues, e.g. by adding examples or suggesting solutions.

  • If you want to propose a solution an existing problem, for simple things (typos, etc.), the easiest would be to just create a PR that I can directly merge. For more complicated changes, however, I would suggest that it is more effective to first discuss the approach at the thread of the issue.

When working on these issues, note that there is extensive code for tests / development purposes outsite the core package in the folde ./code/ on GH. You may find useful information there, and in case you have code intended for development to contribute, you may also create a PR intended for this section.

Also, there are a few technical hints about DHARMA development on the DHARMa GH wiki.

Code of conduct

The development of DHARMA and all its surrounding activities is based on the values of scientific integrity, free software and knowledge, and mutual respect, indepdent of background or world view.

Acknowledgements

A question by Catalina Gutiérrez Chacón provided me with the motivation write the first version of DHARMa. Thanks for useful suggestions to improve DHARMa by Jochen Fründ, Tomer J. Czaczkes, Luis Cayuela Delgado, Alexandre Courtiol, Jim Thorson, Lukas Lohse, jmniehaus, justintimm and many other people that made comments on GitHub, Crossvalidated or via email.

Owner

  • Name: Florian Hartig
  • Login: florianhartig
  • Kind: user
  • Location: Regensburg / Germany
  • Company: @TheoreticalEcology

Professor for Theoretical Ecology at U Regensburg

GitHub Events

Total
  • Fork event: 2
  • Create event: 6
  • Release event: 1
  • Issues event: 53
  • Watch event: 24
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 94
  • Push event: 34
  • Gollum event: 1
  • Pull request review comment event: 6
  • Pull request review event: 11
  • Pull request event: 8
Last Year
  • Fork event: 2
  • Create event: 6
  • Release event: 1
  • Issues event: 53
  • Watch event: 24
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 94
  • Push event: 34
  • Gollum event: 1
  • Pull request review comment event: 6
  • Pull request review event: 11
  • Pull request event: 8

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 975
  • Total Committers: 26
  • Avg Commits per committer: 37.5
  • Development Distribution Score (DDS): 0.202
Past Year
  • Commits: 96
  • Committers: 4
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.281
Top Committers
Name Email Commits
Florian Hartig f****g 778
melina-leite m****e@i****r 69
EttnerAndreas 7****s 26
Florian Hartig f****n@p****e 21
Florian Hartig f****n@U****x 20
florianhartig f****n@U****l 12
olivroy 5****y 9
Kelli Johnson k****n@n****v 4
Ben Bolker b****r@g****m 4
Alexandre Courtiol a****l@g****m 3
danielrettelbach d****h@i****m 3
florianhartig f****n@w****e 3
florianhartig f****n@s****e 3
Florian Hartig f****n@F****l 3
Staffan Betnér s****n@b****u 2
florianhartig f****n@s****e 2
florianhartig f****n@s****e 2
Florian Hartig f****n@r****e 2
Florian Hartig f****n@r****e 2
justintimm 6****m 1
florianhartig f****n@s****e 1
florianhartig f****n@s****e 1
florianhartig f****n@s****e 1
Vassilis Kehayas v****s 1
Darío Hereñú m****a@g****m 1
Cédric Scherer c****r@g****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 189
  • Total pull requests: 32
  • Average time to close issues: 10 months
  • Average time to close pull requests: 3 months
  • Total issue authors: 87
  • Total pull request authors: 8
  • Average comments per issue: 2.85
  • Average comments per pull request: 1.5
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 47
  • Pull requests: 13
  • Average time to close issues: 15 days
  • Average time to close pull requests: 8 days
  • Issue authors: 32
  • Pull request authors: 4
  • Average comments per issue: 1.49
  • Average comments per pull request: 1.08
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • florianhartig (88)
  • melina-leite (6)
  • tqdo (3)
  • akhileshtayade (3)
  • boswel (2)
  • nl101 (2)
  • ajw11 (2)
  • DexterGlass (2)
  • sssiv93 (2)
  • NateLaS (2)
  • gordy2x (1)
  • kc-li (1)
  • MikeACG (1)
  • nmueller18 (1)
  • jpourtois (1)
Pull Request Authors
  • florianhartig (14)
  • melina-leite (9)
  • danielrettelbach (2)
  • bbolker (2)
  • olivroy (2)
  • kellijohnson-NOAA (1)
  • cosminawerneke (1)
  • StaffanBetner (1)
Top Labels
Issue Labels
question (28) enhancement (27) residual pattern (24) Statistical question (17) packageSupport (17) glmmTMB (11) dispersion test (7) wontfix (7) lme4 (7) minor bug (4) mgcv (3) duplicate (2) feature request (2) bug (2) brms (1) gjam (1) sjSDM (1)
Pull Request Labels
bug (2) minor bug (1)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 14,930 last-month
  • Total docker downloads: 104,319
  • Total dependent packages: 12
    (may contain duplicates)
  • Total dependent repositories: 36
    (may contain duplicates)
  • Total versions: 38
  • Total maintainers: 1
cran.r-project.org: DHARMa

Residual Diagnostics for Hierarchical (Multi-Level / Mixed) Regression Models

  • Versions: 28
  • Dependent Packages: 12
  • Dependent Repositories: 36
  • Downloads: 14,930 Last month
  • Docker Downloads: 104,319
Rankings
Stargazers count: 2.4%
Forks count: 3.6%
Dependent repos count: 4.4%
Downloads: 5.0%
Dependent packages count: 5.3%
Average: 7.6%
Docker downloads count: 24.9%
Last synced: about 1 year ago
conda-forge.org: r-dharma
  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Stargazers count: 26.0%
Forks count: 33.2%
Dependent repos count: 34.0%
Average: 36.1%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

DHARMa/DESCRIPTION cran
  • R >= 3.0.2 depends
  • BayesianTools * enhances
  • phyr * enhances
  • rjags * enhances
  • rstan * enhances
  • Matrix * imports
  • ape * imports
  • gap * imports
  • grDevices * imports
  • graphics * imports
  • lme4 * imports
  • lmtest * imports
  • parallel * imports
  • qgam >= 1.3.2 imports
  • stats * imports
  • utils * imports
  • GLMMadaptive * suggests
  • KernSmooth * suggests
  • MASS * suggests
  • glmmTMB >= 1.1.2.3 suggests
  • knitr * suggests
  • mgcViz >= 0.1.9 suggests
  • mgcv * suggests
  • rmarkdown * suggests
  • sfsmisc * suggests
  • spaMM >= 3.2.0 suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite