nimble1.2.1 package

MCMC, Particle Filtering, and Programmable Hierarchical Modeling

buildAuxiliaryFilter

Placeholder for buildAuxiliaryFilter

buildBootstrapFilter

Placeholder for buildBootstrapFilter

buildEnsembleKF

Placeholder for buildEnsembleKF

buildIteratedFilter2

Placeholder for buildIteratedFilter2

buildLiuWestFilter

Placeholder for buildLiuWestFilter

buildMCEM

Builds an MCEM algorithm for a given NIMBLE model

buildMCMC

Create an MCMC object from a NIMBLE model, or an MCMC configuration ob...

calculateWAIC

Calculating WAIC using an offline algorithm

CAR_calcNumIslands

Calculate number of islands based on a CAR adjacency matrix.

CAR-Normal

The CAR-Normal Distribution

CAR-Proper

The CAR-Proper Distribution

asRow

Turn a numeric vector into a single-row or single-column matrix

autoBlock

Automated parameter blocking procedure for efficient MCMC sampling

ADbreak

NIMBLE language function to break tracking of derivatives

ADNimbleList

Data type for the return value of nimDerivs

ADproxyModelClass-class

create an ADproxyModelClass object

any_na

Determine if any values in a vector are NA or NaN

as.carAdjacency

Convert CAR structural parameters to adjacency, weights, num format

as.carCM

Convert weights vector to parameters of dcar_proper distributio

BUGSdeclClass-class

BUGSdeclClass contains the information extracted from one BUGS declara...

buildAGHQGrid

Build Adaptive Gauss-Hermite Quadrature Grid

carBounds

Calculate bounds for the autocorrelation parameter of the `dcar_proper...

carMaxBound

Calculate the upper bound for the autocorrelation parameter of the `dc...

carMinBound

Calculate the lower bound for the autocorrelation parameter of the `dc...

Categorical

The Categorical Distribution

checkInterrupt

Check for interrupt (e.g. Ctrl-C) during nimbleFunction execution. Par...

ChineseRestaurantProcess

The Chinese Restaurant Process Distribution

clearCompiled

Clear compiled objects from a project and unload shared library

CmodelBaseClass-class

Class CmodelBaseClass

CnimbleFunctionBase-class

Class CnimbleFunctionBase

codeBlockClass-class

Class codeBlockClass

compileNimble

compile NIMBLE models and nimbleFunctions

configureMCMC

Build the MCMCconf object for construction of an MCMC object

configureRJ

Configure Reversible Jump for Variable Selection

Constraint

Constraint calculations in NIMBLE

decide

Makes the Metropolis-Hastings acceptance decision, based upon the inpu...

decideAndJump

Creates a nimbleFunction for executing the Metropolis-Hastings jumping...

declare

Explicitly declare a variable in run-time code of a nimbleFunction

deregisterDistributions

Remove user-supplied distributions from use in NIMBLE BUGS models

Dirichlet

The Dirichlet Distribution

distributionInfo

Get information about a distribution

Double-Exponential

The Double Exponential (Laplace) Distribution

eigenNimbleList

eigenNimbleList definition

Exponential

The Exponential Distribution

extractControlElement

Extract named elements from MCMC sampler control list

flat

The Improper Uniform Distribution

getBound

Get value of bound of a stochastic node in a model

getBUGSexampleDir

Get the directory path to one of the classic BUGS examples installed w...

getConditionallyIndependentSets

Get a list of conditionally independent sets of nodes in a nimble mode...

getDefinition

Get nimbleFunction definition

getMacroParameters

EXPERIMENTAL: Get list of parameter names generated by model macros

getNimbleOption

Get NIMBLE Option

getParam

Get value of a parameter of a stochastic node in a model

getSamplesDPmeasure

Get posterior samples for a Dirichlet process measure

getsize

Returns number of rows of modelValues

identityMatrix

Create an Identity matrix (Deprecated)

initializeModel

Performs initialization of nimble model node values and log probabilit...

Interval

Interval calculations

Inverse-Gamma

The Inverse Gamma Distribution

Inverse-Wishart

The Inverse Wishart Distribution

is.nf

check if a nimbleFunction

is.nl

check if a nimbleList

laplace

Laplace approximation and adaptive Gauss-Hermite quadrature

LKJ

The LKJ Distribution for the Cholesky Factor of a Correlation Matrix

makeBoundInfo

Make an object of information about a model-bound pairing for getBound...

makeModelDerivsInfo

Information on model structure used for derivatives

makeParamInfo

Make an object of information about a model-parameter pairing for getP...

MCMCconf-class

Class MCMCconf

model_macro_builder

EXPERIMENTAL: Turn a function into a model macro

modelBaseClass-class

Class modelBaseClass

modelDefClass-class

Class for NIMBLE model definition

modelInitialization

Information on initial values in a NIMBLE model

modelValues

Create a NIMBLE modelValues Object

nfMethod

access (call) a member function of a nimbleFunction

modelValuesBaseClass-class

Class modelValuesBaseClass

modelValuesConf

Create the confs for a custom NIMBLE modelValues object

Multinomial

The Multinomial Distribution

Multivariate-t

The Multivariate t Distribution

MultivariateNormal

The Multivariate Normal Distribution

nfVar

Access or set a member variable of a nimbleFunction

nimble-internal

Functions and Classes Internal to NIMBLE

nimble-math

Mathematical functions for BUGS and nimbleFunction programming

nimble-package

nimble: MCMC, Particle Filtering, and Programmable Hierarchical Modeli...

nimble-R-functions

NIMBLE language functions for R-like vector construction

nimbleCode

Turn BUGS model code into an object for use in nimbleModel or `readB...

nimbleExternalCall

Create a nimbleFunction that wraps a call to external compiled code

nimDim

return sizes of an object whether it is a vector, matrix or array

nimbleFunction

create a nimbleFunction

nimbleFunctionBase-class

Class nimbleFunctionBase

nimbleFunctionList-class

Create a list of nimbleFunctions

nimbleFunctionVirtual

create a virtual nimbleFunction, a base class for other nimbleFunction...

nimbleList

create a nimbleList

nimbleMCMC

Executes one or more chains of NIMBLE's default MCMC algorithm, for a ...

nimbleModel

Create a NIMBLE model from BUGS code

nimbleOptions

NIMBLE Options Settings

nimbleRcall

Make an R function callable from compiled nimbleFunctions (including n...

nimbleType-class

create a nimbleType object

nimCat

cat function for use in nimbleFunctions

nimCopy

Copying function for NIMBLE

nimDerivs

Nimble Derivatives

nimEigen

Spectral Decomposition of a Matrix

nimIntegrate

Integration of One-Dimensional Functions

nimMatrix

Creates matrix or array objects for use in nimbleFunctions

nimNumeric

Creates numeric, integer or logical vectors for use in nimbleFunctions

nimOptim

General-purpose Optimization

nimOptimDefaultControl

Creates a default control argument for nimOptim.

nimOptimMethod

Set or get an optimization function to be used by nimOptim

nimPrint

print function for use in nimbleFunctions

nimStop

Halt execution of a nimbleFunction function method. Part of the NIMBLE...

nimSvd

Singular Value Decomposition of a Matrix

nodeFunctions

calculate, calculateDiff, simulate, or get the current log probabiliti...

optimControlNimbleList

Data type for the control parameter of nimOptim

optimDefaultControl

Creates a deafult control argument for optim (just an empty list).

optimResultNimbleList

Data type for the return value of nimOptim

parameterTransform

Automated transformations of model nodes to unconstrained scales

pow_int

Power function for integer-valued exponent

printErrors

Print error messages after failed compilation

withNimbleOptions

Temporarily set some NIMBLE options.

rankSample

Generates a weighted sample (with replacement) of ranks

readBUGSmodel

Create a NIMBLE BUGS model from a variety of input formats, including ...

registerDistributions

Add user-supplied distributions for use in NIMBLE BUGS models

resize

Resizes a modelValues object

Rmatrix2mvOneVar

Set values of one variable of a modelValues object from an R matrix

RmodelBaseClass-class

Class RmodelBaseClass

run.time

Time execution of NIMBLE code

runCrossValidate

Perform k-fold cross-validation on a NIMBLE model fit by MCMC

runLaplace

Combine steps of running Laplace or adaptive Gauss-Hermite quadrature ...

runMCMC

Run one or more chains of an MCMC algorithm and return samples, summar...

samplers

MCMC Sampling Algorithms

setAndCalculate

Creates a nimbleFunction for setting the values of one or more model n...

setAndCalculateOne

Creates a nimbleFunction for setting the value of a scalar model node,...

setSize

set the size of a numeric variable in NIMBLE

setupMargNodes

Organize model nodes for marginalization

setupOutputs

Explicitly declare objects created in setup code to be preserved and c...

simNodes

Basic nimbleFunctions for calculate, simulate, and getLogProb with a s...

simNodesMV

Basic nimbleFunctions for using a NIMBLE model with sets of stored val...

singleVarAccessClass-class

Class singleVarAccessClass

StickBreakingFunction

The Stick Breaking Function

summaryLaplace

Summarize results from Laplace or adaptive Gauss-Hermite quadrature ap...

svdNimbleList

svdNimbleList definition

t

The t Distribution

testBUGSmodel

Tests BUGS examples in the NIMBLE system

valueInCompiledNimbleFunction

get or set value of member data from a compiled nimbleFunction using a...

values

Access or set values for a set of nodes in a model

waic

Using WAIC

waicDetailsNimbleList

waicDetailsNimbleList definition

waicNimbleList

waicNimbleList definition

Wishart

The Wishart Distribution

A system for writing hierarchical statistical models largely compatible with 'BUGS' and 'JAGS', writing nimbleFunctions to operate models and do basic R-style math, and compiling both models and nimbleFunctions via custom-generated C++. 'NIMBLE' includes default methods for MCMC, Laplace Approximation, Monte Carlo Expectation Maximization, and some other tools. The nimbleFunction system makes it easy to do things like implement new MCMC samplers from R, customize the assignment of samplers to different parts of a model from R, and compile the new samplers automatically via C++ alongside the samplers 'NIMBLE' provides. 'NIMBLE' extends the 'BUGS'/'JAGS' language by making it extensible: New distributions and functions can be added, including as calls to external compiled code. Although most people think of MCMC as the main goal of the 'BUGS'/'JAGS' language for writing models, one can use 'NIMBLE' for writing arbitrary other kinds of model-generic algorithms as well. A full User Manual is available at <https://r-nimble.org>.

  • Maintainer: Christopher Paciorek
  • License: BSD_3_clause + file LICENSE | GPL (>= 2)
  • Last published: 2024-07-30