Flexible BUGS-Compatible System for Hierarchical Statistical Modeling and Algorithm Development


[Up] [Top]

Documentation for package ‘nimble’ version 0.6-3

Help Pages

A B C D E G I K L M N P Q R S T U V W misc

-- A --

addMonitors Class 'MCMCconf'
addMonitors2 Class 'MCMCconf'
addSampler Class 'MCMCconf'
array Creates a array object of arbitrary dimension for use in NIMBLE DSL functions
as.matrix.modelValuesBaseClass-Class Functions and Classes Internal to NIMBLE
asCol Turn a numeric vector into a single-row or single-column matrix
asRow Turn a numeric vector into a single-row or single-column matrix
autoBlock Automated parameter blocking procedure for efficient MCMC sampling
autoBlockClass-Class Functions and Classes Internal to NIMBLE

-- B --

BUGScontextClass-Class Functions and Classes Internal to NIMBLE
BUGSdeclClass BUGSdeclClass contains the information extracted from one BUGS declaration
BUGSdeclClass-class BUGSdeclClass contains the information extracted from one BUGS declaration
BUGSsingleContextClass-Class Functions and Classes Internal to NIMBLE
buildAuxiliaryFilter Create an auxiliary particle filter algorithm to estimate log-likelihood.
buildBootstrapFilter Create a bootstrap particle filter algorithm to estimate log-likelihood.
buildEnsembleKF Create an Ensemble Kalman filter algorithm to sample from latent states.
buildLiuWestFilter Create a Liu and West particle filter algorithm.
buildMCEM Builds an MCEM algorithm from a given NIMBLE model
buildMCMC Create an MCMC function, from an MCMCconf object

-- C --

calcNodes Basic nimbleFunctions for calculate, simulate, and getLogProb with a set of nodes
calcNodesMV Basic nimbleFunctions for using a NIMBLE model with sets of stored values
calculate calculate, calculateDiff, simulate, or get the current log probabilities (densities) a set of nodes in a NIMBLE model
calculateDiff calculate, calculateDiff, simulate, or get the current log probabilities (densities) a set of nodes in a NIMBLE model
calc_dmnormAltParams Functions and Classes Internal to NIMBLE
calc_dmnormConjugacyContributions Functions and Classes Internal to NIMBLE
Categorical The Categorical Distribution
checkConjugacy Class 'modelBaseClass'
checkInterrupt Check for interrupt (e.g. Ctrl-C) during nimbleFunction execution. Part of the NIMBLE language.
cloglog Mathematical functions for BUGS and nimbleFunction programming
CmodelBaseClass Class 'CmodelBaseClass'
CmodelBaseClass-class Class 'CmodelBaseClass'
CmultiNimbleFunctionClass-Class Functions and Classes Internal to NIMBLE
CnimbleFunctionBase Class 'CnimbleFunctionBase'
CnimbleFunctionBase-class Class 'CnimbleFunctionBase'
codeBlockClass Class 'codeBlockClass'
codeBlockClass-class Class 'codeBlockClass'
combine_MCMC_comparison_results Combine multiple objects returned by compareMCMCs
compareMCMCs Run multiple MCMCs (packages or NIMBLE cases) for multiple models and return summary results
compileNimble compile NIMBLE models and nimbleFunctions
configureMCMC Build the MCMCconf object for construction of an MCMC object
conjugacyClass-Class Functions and Classes Internal to NIMBLE
conjugacyRelationshipsClass-Class Functions and Classes Internal to NIMBLE
Constraint Constraint calculations in NIMBLE
cppBUGSmodelClass-Class Functions and Classes Internal to NIMBLE
cppCodeFileClass-Class Functions and Classes Internal to NIMBLE
cppCPPfileClass-Class Functions and Classes Internal to NIMBLE
cppHfileClass-Class Functions and Classes Internal to NIMBLE
cppModelValuesClass-Class Functions and Classes Internal to NIMBLE
cppNamedObjectsClass-Class Functions and Classes Internal to NIMBLE
cppNimbleFunctionClass-Class Functions and Classes Internal to NIMBLE
cppProjectClass-Class Functions and Classes Internal to NIMBLE
cppVirtualNimbleFunctionClass-Class Functions and Classes Internal to NIMBLE
crossLevel MCMC Sampling Algorithms
cube Mathematical functions for BUGS and nimbleFunction programming

-- D --

dcat The Categorical Distribution
dconstraint Constraint calculations in NIMBLE
ddirch The Dirichlet Distribution
decide Makes the Metropolis-Hastings acceptance decision, based upon the input (log) Metropolis-Hastings ratio
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.
declare Explicitly declare a variable in run-time code of a nimbleFunction
dependentClass-Class Functions and Classes Internal to NIMBLE
deregisterDistributions Remove user-supplied distributions from use in NIMBLE BUGS models
dexp_nimble The Exponential Distribution
dinterval Interval calculations
Dirichlet The Dirichlet Distribution
dirichlet The Dirichlet Distribution
distClass-Class Functions and Classes Internal to NIMBLE
distributionInfo Get information about a distribution
distributionsClass-Class Functions and Classes Internal to NIMBLE
dmnorm_chol The Multivariate Normal Distribution
dmulti The Multinomial Distribution
dmvt_chol The Multivariate t Distribution
dt_nonstandard The t Distribution
dwish_chol The Wishart Distribution

-- E --

expit Mathematical functions for BUGS and nimbleFunction programming
Exponential The Exponential Distribution
exprClass-Class Functions and Classes Internal to NIMBLE
exprTypeInfoClass-Class Functions and Classes Internal to NIMBLE

-- G --

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 with NIMBLE package
getDefinition Get nimbleFunction definition
getDependencies Class 'modelBaseClass'
getDimension Class 'modelBaseClass'
getDistribution Class 'modelBaseClass'
getDistributionInfo Get information about a distribution
getLoadingNamespace return the namespace in which a nimbleFunction is being loaded
getLogProb calculate, calculateDiff, simulate, or get the current log probabilities (densities) a set of nodes in a NIMBLE model
getLogProbNodes Basic nimbleFunctions for calculate, simulate, and getLogProb with a set of nodes
getLogProbNodesMV Basic nimbleFunctions for using a NIMBLE model with sets of stored values
getMonitors Class 'MCMCconf'
getNimbleOption Get NIMBLE Option
getNimbleProject Functions and Classes Internal to NIMBLE
getNodeFunctionIndexedInfo Functions and Classes Internal to NIMBLE
getNodeNames Class 'modelBaseClass'
getParam Get value of a parameter of a stochastic node in a model
getParamNames Get information about a distribution
getSamplers Class 'MCMCconf'
getsize Returns number of rows of modelValues
getType Get information about a distribution
getVarNames Class 'modelBaseClass'

-- I --

icloglog Mathematical functions for BUGS and nimbleFunction programming
identityMatrix Create an Identity matrix
ilogit Mathematical functions for BUGS and nimbleFunction programming
indexedNodeInfoTableClass-Class Functions and Classes Internal to NIMBLE
initializeModel Performs initialization of nimble model node values and log probabilities
inprod Mathematical functions for BUGS and nimbleFunction programming
integer Creates an integer vector for use in NIMBLE DSL functions
Interval Interval calculations
inverse Mathematical functions for BUGS and nimbleFunction programming
iprobit Mathematical functions for BUGS and nimbleFunction programming
is.nf check if a nimbleFunction
isBinary Class 'modelBaseClass'
isData Class 'modelBaseClass'
isDeterm Class 'modelBaseClass'
isDiscrete Class 'modelBaseClass'
isEndNode Class 'modelBaseClass'
isStoch Class 'modelBaseClass'
isTruncated Class 'modelBaseClass'
isUnivariate Class 'modelBaseClass'
isUserDefined Get information about a distribution

-- K --

keywordInfoClass-Class Functions and Classes Internal to NIMBLE

-- L --

logdet Mathematical functions for BUGS and nimbleFunction programming
logfact Mathematical functions for BUGS and nimbleFunction programming
loggam Mathematical functions for BUGS and nimbleFunction programming
logit Mathematical functions for BUGS and nimbleFunction programming

-- M --

makeBoundInfo Make an object of information about a model-bound pairing for getBound. Used internally
MakeCustomModelClass-Class Functions and Classes Internal to NIMBLE
makeCustomModelValuesClass-Class Functions and Classes Internal to NIMBLE
makeParamInfo Make an object of information about a model-parameter pairing for getParam. Used internally
make_MCMC_comparison_pages Make html pages summarizing results from compareMCMCs
mapsClass-Class Functions and Classes Internal to NIMBLE
matrix Creates a matrix object for use in NIMBLE DSL functions
MCMCconf Class 'MCMCconf'
MCMCconf-class Class 'MCMCconf'
MCMCsuite Executes multiple MCMC algorithms and organizes results.
MCMCsuiteClass Class 'MCMCsuiteClass'
MCMCsuiteClass-class Class 'MCMCsuiteClass'
modelBaseClass Class 'modelBaseClass'
modelBaseClass-class Class 'modelBaseClass'
modelDefClass Class for NIMBLE model definition
modelDefClass-class Class for NIMBLE model definition
modelDefInfoClass-Class Functions and Classes Internal to NIMBLE
modelValues Create a NIMBLE modelValues Object
modelValuesBaseClass Class 'modelValuesBaseClass'
modelValuesBaseClass-class Class 'modelValuesBaseClass'
modelValuesConf Create the confs for a custom NIMBLE modelValues object
Multinomial The Multinomial Distribution
multinomial The Multinomial Distribution
Multivariate-t The Multivariate t Distribution
multivariate-t The Multivariate t Distribution
MultivariateNormal The Multivariate Normal Distribution
mvInfoClass-Class Functions and Classes Internal to NIMBLE
mvt The Multivariate t Distribution

-- N --

newModel Class 'modelBaseClass'
nfCompilationInfoClass-Class Functions and Classes Internal to NIMBLE
nfMethod access (call) a member function of a nimbleFunction
nfVar Access or set a member variable of a nimbleFunction
nfVar<- Access or set a member variable of a nimbleFunction
nimArray Creates a array object of arbitrary dimension for use in NIMBLE DSL functions
nimbleCode Turn BUGS model code into an object for use in 'nimbleModel' or 'readBUGSmodel'
nimbleFunction create a nimbleFunction
nimbleFunctionBase Class 'nimbleFunctionBase'
nimbleFunctionBase-class Class 'nimbleFunctionBase'
nimbleFunctionList Create a list of nimbleFunctions
nimbleFunctionList-class Create a list of nimbleFunctions
nimbleFunctionVirtual create a virtual nimbleFunction, a base class for other nimbleFunctions
nimbleGraphClass-Class Functions and Classes Internal to NIMBLE
nimbleInternalFunctions Functions and Classes Internal to NIMBLE
nimbleModel Create a NIMBLE model from BUGS code
nimbleOptions NIMBLE Options Settings
nimbleProjectClass-Class Functions and Classes Internal to NIMBLE
nimbleUserNamespace Functions and Classes Internal to NIMBLE
nimCat cat function for use in nimbleFunctions
nimCopy Copying function for NIMBLE
nimDim return sizes of an object whether it is a vector, matrix or array
nimEquals Mathematical functions for BUGS and nimbleFunction programming
nimInteger Creates an integer vector for use in NIMBLE DSL functions
nimMatrix Creates a matrix object for use in NIMBLE DSL functions
nimNumeric Creates a numeric vector for use in NIMBLE DSL functions
nimPrint print function for use in nimbleFunctions
nimStep Mathematical functions for BUGS and nimbleFunction programming
nimStop Halt execution of a nimbleFunction function method. Part of the NIMBLE language
nimSwitch Mathematical functions for BUGS and nimbleFunction programming
nodeFunctions calculate, calculateDiff, simulate, or get the current log probabilities (densities) a set of nodes in a NIMBLE model
numeric Creates a numeric vector for use in NIMBLE DSL functions

-- P --

pexp_nimble The Exponential Distribution
phi Mathematical functions for BUGS and nimbleFunction programming
posteriorClass-Class Functions and Classes Internal to NIMBLE
posterior_predictive MCMC Sampling Algorithms
pow Mathematical functions for BUGS and nimbleFunction programming
pqDefined Get information about a distribution
printSamplers Class 'MCMCconf'
probit Mathematical functions for BUGS and nimbleFunction programming
pt_nonstandard The t Distribution

-- Q --

qexp_nimble The Exponential Distribution
qt_nonstandard The t Distribution

-- R --

rankSample Generates a weighted sample (with replacement) of ranks
rcat The Categorical Distribution
RCfunctionCompileClass-Class Functions and Classes Internal to NIMBLE
RCfunInfoClass-Class Functions and Classes Internal to NIMBLE
rconstraint Constraint calculations in NIMBLE
rdirch The Dirichlet Distribution
readBUGSmodel Create a NIMBLE BUGS model from a variety of input formats, including BUGS model files
registerDistributions Add user-supplied distributions for use in NIMBLE BUGS models
removeSamplers Class 'MCMCconf'
rename_MCMC_comparison_method Rename a method in an object returned by compareMCMCs
resetData Class 'modelBaseClass'
resetMonitors Class 'MCMCconf'
reshape_comparison_results Convert comparison results to a more general format
resize Resizes a modelValues object
rexp_nimble The Exponential Distribution
rinterval Interval calculations
RMakeCustomModelClass-Class Functions and Classes Internal to NIMBLE
Rmatrix2mvOneVar Set values of one variable of a modelValues object from an R matrix
rmnorm_chol The Multivariate Normal Distribution
RmodelBaseClass Class 'RmodelBaseClass'
RmodelBaseClass-class Class 'RmodelBaseClass'
rmulti The Multinomial Distribution
rmvt_chol The Multivariate t Distribution
rt_nonstandard The t Distribution
run.time Time execution of NIMBLE code
runMCMC Run one or more chains of an MCMC algorithm and extract samples
RW MCMC Sampling Algorithms
rwish_chol The Wishart Distribution
RW_block MCMC Sampling Algorithms
RW_llFunction MCMC Sampling Algorithms
RW_llFunction_block MCMC Sampling Algorithms
RW_multinomial MCMC Sampling Algorithms
RW_PF MCMC Sampling Algorithms
RW_PF_block MCMC Sampling Algorithms

-- S --

sampler MCMC Sampling Algorithms
samplers MCMC Sampling Algorithms
sampler_BASE MCMC Sampling Algorithms
sampler_binary MCMC Sampling Algorithms
sampler_crossLevel MCMC Sampling Algorithms
sampler_ess MCMC Sampling Algorithms
sampler_posterior_predictive MCMC Sampling Algorithms
sampler_RW MCMC Sampling Algorithms
sampler_RW_block MCMC Sampling Algorithms
sampler_RW_llFunction MCMC Sampling Algorithms
sampler_RW_llFunction_block MCMC Sampling Algorithms
sampler_RW_multinomial MCMC Sampling Algorithms
sampler_RW_PF MCMC Sampling Algorithms
sampler_RW_PF_block MCMC Sampling Algorithms
sampler_slice MCMC Sampling Algorithms
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.
setAndCalculateDiff 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.
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.
setData Class 'modelBaseClass'
setInits Class 'modelBaseClass'
setSamplers Class 'MCMCconf'
setSize set the size of a numeric variable in NIMBLE
setThin Class 'MCMCconf'
setThin2 Class 'MCMCconf'
setupCodeTemplateClass-Class Functions and Classes Internal to NIMBLE
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
simNodesMV Basic nimbleFunctions for using a NIMBLE model with sets of stored values
simulate calculate, calculateDiff, simulate, or get the current log probabilities (densities) a set of nodes in a NIMBLE model
singleModelValuesAccess Functions and Classes Internal to NIMBLE
singleModelValuesAccessClass-Class Functions and Classes Internal to NIMBLE
singleVarAccessClass Class 'singleVarAccessClass'
singleVarAccessClass-class Class 'singleVarAccessClass'
slice MCMC Sampling Algorithms

-- T --

t The t Distribution
testBUGSmodel Tests BUGS examples in the NIMBLE system
topologicallySortNodes Class 'modelBaseClass'

-- U --

updateMCMCcomparisonWithHighOrderESS Re-estimate effective sample size from results of compareMCMCs

-- V --

valueInCompiledNimbleFunction get or set value of member data from a compiled nimbleFunction using a multi-interface
values Access or set values for a set of nodes in a model
values<- Access or set values for a set of nodes in a model
varInfoClass-Class Functions and Classes Internal to NIMBLE

-- W --

Wishart The Wishart Distribution
wishart The Wishart Distribution

-- misc --

[,CmodelValues-method,ANY,ANY Class 'modelValuesBaseClass'
[,CmodelValues-method,character,missing Class 'modelValuesBaseClass'
[-method Class 'modelValuesBaseClass'
[-method Functions and Classes Internal to NIMBLE
[<--method Class 'modelValuesBaseClass'
[<--method Functions and Classes Internal to NIMBLE
[[-method Class 'modelBaseClass'
[[-method Class 'modelValuesBaseClass'
[[-method Functions and Classes Internal to NIMBLE
[[<--method Class 'modelBaseClass'
[[<--method Class 'modelValuesBaseClass'
[[<--method Functions and Classes Internal to NIMBLE