Learn R Programming

⚠️There's a newer version (1.3.0) of this package.Take me there.

UNIX

One can specify the path to where the Eigen header files are located and also whether to link common C++ files into every DSO/DLL we create or whether to treat the files as an extra library with:

R CMD INSTALL --configure-args='--with-eigen=/home/duncan/local --enable-lib' nimble

or, within R

install.packages("nimble", configure.args = c("--with-eigen=/home/duncan/local", "--enable-lib=true"), repos = NULL)

Windows

Typically, you need the R developer tools (i.e., compiler, make, etc.) to use nimble. Accordingly, it is quite straightforward to install the package from source as you will have the necessary tools already installed. These are available from the Rtools page on CRAN.

To install the package from source, from within R,

install.packages("nimble", type = "source", INSTALL_opts = "--merge-multiarch")

or from a local copy of the source package,

install.packages("nimble_0.6-2.tar.gz", repos = NULL, INSTALL_opts = "--merge-multiarch")

Alternatively, use the shell command (in the DOS Command prompt)

R CMD INSTALL --merge-multiarch nimble_0.6-9.tar.gz

Of course, you can also compile directly from a clone of the git repository:

R CMD INSTALL --merge-multiarch nimble

The --merge-multiarch is necessary when using a version of R that supports both 32 and 64 bit. This option to installation will ensure that create both 32 and 64 bit installations.

Creating a Windows Binary

R CMD build nimble
R CMD INSTALL --build --merge-multiarch nimble_0.6-9.tar.gz

We need to create the .tar.gz file first, hence the first command.

Copy Link

Version

Install

install.packages('nimble')

Monthly Downloads

3,227

Version

1.1.0

License

BSD_3_clause + file LICENSE | GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Christopher Paciorek

Last Published

January 31st, 2024

Functions in nimble (1.1.0)

LKJ

The LKJ Distribution for the Cholesky Factor of a Correlation Matrix
ADbreak

NIMBLE language function to break tracking of derivatives
Constraint

Constraint calculations in NIMBLE
CnimbleFunctionBase-class

Class CnimbleFunctionBase
MCMCsuite

Placeholder for MCMCsuite
Exponential

The Exponential Distribution
StickBreakingFunction

The Stick Breaking Function
Multinomial

The Multinomial Distribution
Multivariate-t

The Multivariate t Distribution
Wishart

The Wishart Distribution
Interval

Interval calculations
Dirichlet

The Dirichlet Distribution
buildLiuWestFilter

Placeholder for buildLiuWestFilter
buildIteratedFilter2

Placeholder for buildIteratedFilter2
MCMCconf-class

Class MCMCconf
Double-Exponential

The Double Exponential (Laplace) Distribution
checkInterrupt

Check for interrupt (e.g. Ctrl-C) during nimbleFunction execution. Part of the NIMBLE language.
clearCompiled

Clear compiled objects from a project and unload shared library
distributionInfo

Get information about a distribution
deregisterDistributions

Remove user-supplied distributions from use in NIMBLE BUGS models
Inverse-Gamma

The Inverse Gamma Distribution
as.carAdjacency

Convert CAR structural parameters to adjacency, weights, num format
autoBlock

Automated parameter blocking procedure for efficient MCMC sampling
Inverse-Wishart

The Inverse Wishart Distribution
any_na

Determine if any values in a vector are NA or NaN
flat

The Improper Uniform Distribution
buildAuxiliaryFilter

Placeholder for buildAuxiliaryFilter
carMinBound

Calculate the lower bound for the autocorrelation parameter of the dcar_proper distribution
declare

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

Calculate the upper bound for the autocorrelation parameter of the dcar_proper distribution
decideAndJump

Creates a nimbleFunction for executing the Metropolis-Hastings jumping decision, and updating values in the model, or in a carbon copy modelValues object, accordingly.
getBound

Get value of bound of a stochastic node in a model
configureMCMC

Build the MCMCconf object for construction of an MCMC object
buildEnsembleKF

Placeholder for buildEnsembleKF
compileNimble

compile NIMBLE models and nimbleFunctions
buildBootstrapFilter

Placeholder for buildBootstrapFilter
getBUGSexampleDir

Get the directory path to one of the classic BUGS examples installed with NIMBLE package
identityMatrix

Create an Identity matrix (Deprecated)
getDefinition

Get nimbleFunction definition
makeBoundInfo

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

Laplace approximation
getMacroParameters

EXPERIMENTAL: Get list of parameter names generated by model macros
Rmatrix2mvOneVar

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

Calculating WAIC using an offline algorithm
RmodelBaseClass-class

Class RmodelBaseClass
as.carCM

Convert weights vector to parameters of dcar_proper distributio
asRow

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

The Multivariate Normal Distribution
buildMCEM

Builds an MCEM algorithm from a given NIMBLE model
compareMCMCs

Placeholder for compareMCMCs
codeBlockClass-class

Class codeBlockClass
buildMCMC

Create an MCMC object from a NIMBLE model, or an MCMC configuration object
model_macro_builder

EXPERIMENTAL: Turn a function into a model macro builder A model macro expands one line of code in a nimbleModel into one or more new lines. This supports compact programming by defining re-usable modules. model_macro_builder takes as input a function that constructs new lines of model code from the original line of code. It returns a function suitable for internal use by nimbleModel that arranges arguments for input function. Macros are an experimental feature and are available only after setting nimbleOptions(enableModelMacros = TRUE).
nimStop

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

access (call) a member function of a nimbleFunction
nimbleList

create a nimbleList
nimSvd

Singular Value Decomposition of a Matrix
nimbleMCMC

Executes one or more chains of NIMBLE's default MCMC algorithm, for a model specified using BUGS code
is.nf

check if a nimbleFunction
getConditionallyIndependentSets

Get a list of conditionally independent sets of nodes in a nimble model
nimIntegrate

Integration of One-Dimensional Functions
nimbleFunctionList-class

Create a list of nimbleFunctions
nimMatrix

Creates matrix or array objects for use in nimbleFunctions
nimCopy

Copying function for NIMBLE
is.nl

check if a nimbleList
nimDerivs

Nimble Derivatives
nimbleFunctionVirtual

create a virtual nimbleFunction, a base class for other nimbleFunctions
parameterTransform

Automated transformations of model nodes to unconstrained scales
eigenNimbleList

eigenNimbleList definition
extractControlElement

Extract named elements from MCMC sampler control list
nimOptimDefaultControl

Creates a default control argument for nimOptim.
pow_int

Power function for integer-valued exponent
nimble-package

nimble: MCMC, Particle Filtering, and Programmable Hierarchical Modeling
nimble-math

Mathematical functions for BUGS and nimbleFunction programming
readBUGSmodel

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

print function for use in nimbleFunctions
nimbleType-class

create a nimbleType object
registerDistributions

Add user-supplied distributions for use in NIMBLE BUGS models
nimbleRcall

Make an R function callable from compiled nimbleFunctions (including nimbleModels).
nodeFunctions

calculate, calculateDiff, simulate, or get the current log probabilities (densities) a set of nodes in a NIMBLE model
optimControlNimbleList

Data type for the control parameter of nimOptim
initializeModel

Performs initialization of nimble model node values and log probabilities
sampler_BASE

MCMC Sampling Algorithms
nimNumeric

Creates numeric, integer or logical vectors for use in nimbleFunctions
setAndCalculate

Creates a nimbleFunction for setting the values of one or more model nodes, calculating the associated deterministic dependents and logProb values, and returning the total sum log-probability.
nimEigen

Spectral Decomposition of a Matrix
nimOptim

General-purpose Optimization
modelValues

Create a NIMBLE modelValues Object
modelInitialization

Information on initial values in a NIMBLE model
nimDim

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

waicDetailsNimbleList definition
t

The t Distribution
svdNimbleList

svdNimbleList definition
waicNimbleList

waicNimbleList definition
resize

Resizes a modelValues object
run.time

Time execution of NIMBLE code
testBUGSmodel

Tests BUGS examples in the NIMBLE system
valueInCompiledNimbleFunction

get or set value of member data from a compiled nimbleFunction using a multi-interface
carBounds

Calculate bounds for the autocorrelation parameter of the dcar_proper distribution
decide

Makes the Metropolis-Hastings acceptance decision, based upon the input (log) Metropolis-Hastings ratio
getNimbleOption

Get NIMBLE Option
configureRJ

Configure Reversible Jump for Variable Selection
makeParamInfo

Make an object of information about a model-parameter pairing for getParam. Used internally
makeModelDerivsInfo

Information on model structure used for derivatives
getParam

Get value of a parameter of a stochastic node in a model
modelValuesBaseClass-class

Class modelValuesBaseClass
getsize

Returns number of rows of modelValues
modelDefClass-class

Class for NIMBLE model definition
getSamplesDPmeasure

Get posterior samples for a Dirichlet process measure
modelBaseClass-class

Class modelBaseClass
nfVar

Access or set a member variable of a nimbleFunction
simNodes

Basic nimbleFunctions for calculate, simulate, and getLogProb with a set of nodes
simNodesMV

Basic nimbleFunctions for using a NIMBLE model with sets of stored values
setupOutputs

Explicitly declare objects created in setup code to be preserved and compiled as member data
setupMargNodes

Organize model nodes for marginalization
nimCat

cat function for use in nimbleFunctions
nimble-R-functions

NIMBLE language functions for R-like vector construction
nimble-internal

Functions and Classes Internal to NIMBLE
nimbleCode

Turn BUGS model code into an object for use in nimbleModel or readBUGSmodel
nimbleModel

Create a NIMBLE model from BUGS code
nimbleExternalCall

Create a nimbleFunction that wraps a call to external compiled code
runCrossValidate

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

NIMBLE Options Settings
runMCMC

Run one or more chains of an MCMC algorithm and return samples, summary and/or WAIC
setAndCalculateOne

Creates a nimbleFunction for setting the value of a scalar model node, calculating the associated deterministic dependents and logProb values, and returning the total sum log-probability.
setSize

set the size of a numeric variable in NIMBLE
values

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

Create the confs for a custom NIMBLE modelValues object
nimbleFunctionBase-class

Class nimbleFunctionBase
nimbleFunction

create a nimbleFunction
optimDefaultControl

printErrors

Print error messages after failed compilation
optimResultNimbleList

Data type for the return value of nimOptim
rankSample

Generates a weighted sample (with replacement) of ranks
waic

Using WAIC
singleVarAccessClass-class

Class singleVarAccessClass
summaryLaplace

Summarize results from Laplace approximation
withNimbleOptions

Temporarily set some NIMBLE options.
CmodelBaseClass-class

Class CmodelBaseClass
BUGSdeclClass-class

BUGSdeclClass contains the information extracted from one BUGS declaration
ADNimbleList

Data type for the return value of nimDerivs
CAR_calcNumIslands

Calculate number of islands based on a CAR adjacency matrix.
ChineseRestaurantProcess

The Chinese Restaurant Process Distribution
CAR-Normal

The CAR-Normal Distribution
Categorical

The Categorical Distribution
ADproxyModelClass-class

create an ADproxyModelClass object
CAR-Proper

The CAR-Proper Distribution