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

0.8.0

License

BSD_3_clause + file LICENSE | GPL (>= 2)

Maintainer

Christopher Paciorek

Last Published

June 2nd, 2019

Functions in nimble (0.8.0)

Constraint

Constraint calculations in NIMBLE
CmodelBaseClass-class

Class CmodelBaseClass
ADNimbleList

BUGSdeclClass-class

BUGSdeclClass contains the information extracted from one BUGS declaration
ChineseRestaurantProcess

The Chinese Restaurant Process Distribution
Categorical

The Categorical Distribution
CnimbleFunctionBase-class

Class CnimbleFunctionBase
CAR_calcNumIslands

Calculate number of islands based on a CAR adjacency matrix.
CAR-Normal

The CAR-Normal Distribution
CAR-Proper

The CAR-Proper Distribution
Exponential

The Exponential Distribution
Inverse-Wishart

The Inverse Wishart Distribution
MultivariateNormal

The Multivariate Normal Distribution
Inverse-Gamma

The Inverse Gamma Distribution
Multivariate-t

The Multivariate t Distribution
Interval

Interval calculations
StickBreakingFunction

The Stick Breaking Function
Wishart

The Wishart Distribution
buildMCEM

Builds an MCEM algorithm from a given NIMBLE model
buildMCMC

Create an MCMC function from a NIMBLE model, or an MCMC configuration object
buildEnsembleKF

Create an Ensemble Kalman filter algorithm to sample from latent states.
MCMCsuite

Placeholder for MCMCsuite
autoBlock

Automated parameter blocking procedure for efficient MCMC sampling
asRow

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

Class MCMCconf
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
getDefinition

Get nimbleFunction definition
configureRJ

Configure Reversible Jump Sampler
carMaxBound

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

[[' = 'outputCppArrayIndex2',
Double-Exponential

The Double Exponential (Laplace) Distribution
Dirichlet

The Dirichlet Distribution
RmodelBaseClass-class

Class RmodelBaseClass
Rmatrix2mvOneVar

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

The Multinomial Distribution
buildLiuWestFilter

Create a Liu and West particle filter algorithm.
deregisterDistributions

Remove user-supplied distributions from use in NIMBLE BUGS models
flat

The Improper Uniform Distribution
distributionInfo

Get information about a distribution
eigenNimbleList

eigenNimbleList definition
modelDefClass-class

Class for NIMBLE model definition
modelValues

Create a NIMBLE modelValues Object
modelValuesConf

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

Class modelValuesBaseClass
nimMatrix

Creates matrix or array objects for use in nimbleFunctions
nimNumeric

Creates numeric, integer or logical vectors for use in nimbleFunctions
modelBaseClass-class

Class modelBaseClass
makeParamInfo

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

return the namespace in which a nimbleFunction is being loaded
codeBlockClass-class

Class codeBlockClass
buildBootstrapFilter

Create a bootstrap particle filter algorithm to estimate log-likelihood.
buildAuxiliaryFilter

Create an auxiliary particle filter algorithm to estimate log-likelihood.
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.
nimbleFunctionBase-class

Class nimbleFunctionBase
as.carAdjacency

Convert CAR structural parameters to adjacency, weights, num format
nimbleFunctionList-class

Create a list of nimbleFunctions
optimControlNimbleList

compareMCMCs

Placeholder for compareMCMCs
getNimbleOption

Get NIMBLE Option
identityMatrix

Create an Identity matrix (Deprecated)
getParam

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

Access or set a member variable of a nimbleFunction
optimDefaultControl

nimCat

cat function for use in nimbleFunctions
nimble-R-functions

NIMBLE language functions for R-like vector construction
nimSvd

Singular Value Decomposition of a Matrix
initializeModel

Performs initialization of nimble model node values and log probabilities
nimbleExternalCall

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

Nimble Derivatives
nimCopy

Copying function for NIMBLE
nimble-math

Mathematical functions for BUGS and nimbleFunction programming
nimble-internal

Functions and Classes Internal to NIMBLE
nimbleMCMC

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

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

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

Resizes a modelValues object
nimbleType-class

create a nimbleType object
nimbleFunction

create a nimbleFunction
carMinBound

Calculate the lower bound for the autocorrelation parameter of the dcar_proper distribution
as.carCM

Convert weights vector to parameters of dcar_proper distributio
runCrossValidate

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

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

Time execution of NIMBLE code
checkInterrupt

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

compile NIMBLE models and nimbleFunctions
values

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

Tests BUGS examples in the NIMBLE system
valueInCompiledNimbleFunction

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

Temporarily set some NIMBLE options.
nimPrint

print function for use in nimbleFunctions
is.nl

check if a nimbleList
nfMethod

access (call) a member function of a nimbleFunction
makeBoundInfo

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

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

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

Halt execution of a nimbleFunction function method. Part of the NIMBLE language
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).
nimbleModel

Create a NIMBLE model from BUGS code
nimbleOptions

NIMBLE Options Settings
configureMCMC

Build the MCMCconf object for construction of an MCMC object
nimbleRcall

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

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

Class singleVarAccessClass
samplerAssignmentRules-class

Class samplerAssignmentRules
simNodesMV

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

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

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

create a nimbleList
rankSample

Generates a weighted sample (with replacement) of ranks
sampler_BASE

MCMC Sampling Algorithms
getsize

Returns number of rows of modelValues
getSamplesDPmeasure

Get posterior samples for a Dirichlet process measure
is.na.vec

Determine if any values in a vector are NA or NaN
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.
setupOutputs

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

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

nimble
nimDim

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

nimEigen

Spectral Decomposition of a Matrix
nimOptim

is.nf

check if a nimbleFunction
optimResultNimbleList

nimbleCode

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

Print error messages after failed compilation
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
svdNimbleList

svdNimbleList definition
t

The t Distribution