adnuts

An R package for NUTS sampling using ADMB

https://github.com/cole-monnahan-noaa/adnuts

Science Score: 49.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
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    4 of 5 committers (80.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.0%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

An R package for NUTS sampling using ADMB

Basic Info
Statistics
  • Stars: 24
  • Watchers: 2
  • Forks: 14
  • Open Issues: 2
  • Releases: 5
Created over 9 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License

README.md

adnuts

main: R-CMD-check dev: R-CMD-check codecov CRAN RStudio mirror downloads

The aim of 'adnuts' (pronounced A-D nuts) is to provide advanced MCMC sampling for 'TMB' and 'ADMB' models. For TMB models it uses the sparse NUTS (SNUTS; Monnahan et al. in prep) algorithm to decorrelate the posterior using the joint precision matrix. The R package 'tmbstan' (available on CRAN) provides an alternative for TMB which more closely links to Stan. Until the development of SNUTS, 'adnuts' was primarily used for ADMB models. For the foreseeable future SNUTS via 'adnuts' is likely to be the best general option for TMB users.

For ADMB it mimics 'Stan' in functionality and feel, specifically providing no-U-turn (NUTS) sampling with adaptive mass matrix and parallel execution. Development of ADMB features is winding down, but functionality expected to be maintained in the coming years.

See the following papers for an introduction to the package capabilities, and contrast with tmbstan:

Monnahan CC, Kristensen K (2018) No-U-turn sampling for fast Bayesian inference in ADMB and TMB: Introducing the adnuts and tmbstan R packages. PLoS ONE 13(5):e0197954. https://doi.org/10.1371/journal.pone.0197954

Monnahan CC, Thorson, J.T., Kristensen, K, and Carpenter, B (in prep). Leveraging sparsity to improve no-u-turn sampling efficiency of hierarchical Bayesian models.

Installation

To use SNUTS with TMB first install the StanEstimators package which is not on CRAN but can be installed as:

```

we recommend running this is a fresh R session or restarting your current session

install.packages('StanEstimators', repos = c('https://andrjohns.r-universe.dev', 'https://cloud.r-project.org')) ```

Then install the GitHub version of 'adnuts':

```` devtools::install_github('Cole-Monnahan-NOAA/adnuts')

````

A quick test of functionality is:

library(adnuts) TMB::runExample('simple') mcmc <- sample_snuts(obj, num_samples=500)

A brief demonstration file is the best place to help get you started, and there is also a user guide: see vignette('adnuts') for the basics and this online article for more detailed information.

Disclaimer

“The United States Department of Commerce (DOC) GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.”

NOAA Fisheries

U.S. Department of Commerce | National Oceanographic and Atmospheric Administration | NOAA Fisheries

Owner

  • Name: Cole Monnahan
  • Login: Cole-Monnahan-NOAA
  • Kind: user
  • Location: Seattle, WA

Quantitative ecologist at NOAA's AFSC

GitHub Events

Total
  • Issues event: 8
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 36
  • Pull request event: 1
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 8
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 36
  • Pull request event: 1
  • Fork event: 1
  • Create event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 444
  • Total Committers: 5
  • Avg Commits per committer: 88.8
  • Development Distribution Score (DDS): 0.356
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
colemonnahan m****c@u****u 286
Cole-Monnahan-NOAA c****n@n****v 153
Quang C. Huynh q****h@v****u 3
kaskr k****r@d****k 1
Iago Mosqueira i****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 22
  • Total pull requests: 26
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 18 days
  • Total issue authors: 12
  • Total pull request authors: 7
  • Average comments per issue: 1.64
  • Average comments per pull request: 0.15
  • Merged pull requests: 26
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 18 hours
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Cole-Monnahan-NOAA (6)
  • jimianelli (5)
  • quantifish (2)
  • iantaylor-NOAA (1)
  • BenWilliams-NOAA (1)
  • wStockhausen (1)
  • iagomosqueira (1)
  • Maschette (1)
  • haleyoleynik (1)
  • k-doering-NOAA (1)
  • jmannseth (1)
  • aaronmberger-nwfsc (1)
Pull Request Authors
  • colemonnahan (11)
  • Cole-Monnahan-NOAA (6)
  • k-doering-NOAA (2)
  • quang-huynh (2)
  • iagomosqueira (2)
  • James-Thorson-NOAA (2)
  • kaskr (1)
Top Labels
Issue Labels
enhancement (2) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 327 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 3
  • Total versions: 3
  • Total maintainers: 1
cran.r-project.org: adnuts

No-U-Turn MCMC Sampling for 'ADMB' Models

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 327 Last month
Rankings
Forks count: 5.2%
Stargazers count: 11.8%
Dependent repos count: 16.5%
Average: 19.5%
Dependent packages count: 28.7%
Downloads: 35.5%
Maintainers (1)
Last synced: 7 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.6.0 depends
  • snowfall >= 1.84.6.1 depends
  • R2admb * imports
  • ellipse * imports
  • ggplot2 * imports
  • rlang * imports
  • rstan * imports
  • TMB * suggests
  • knitr * suggests
  • matrixcalc >= 1.0.3 suggests
  • rmarkdown * suggests
  • shinystan >= 2.5.0 suggests
  • stats * suggests
  • testthat >= 2.1.0 suggests
  • withr * suggests
.github/workflows/R-CMD-check.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite
.github/workflows/calc-coverage.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r master composite