RBaM1.1.2 package

Bayesian Modeling: Estimate a Computer Model and Make Uncertain Predictions

addQuotes

Add double quotes to a string or to each element of a string vector

applyMetropolisRule

Metropolis Rule

BaM

Run BaM

blocDiag

Bloc-diagonal matrix constructor

checkFormula

Check a formula make sense within a given namespace

dataset

dataset object constructor.

densityPlot

densityPlot

downloadBaM

BaM downloader

foundBaM

Was BaM executable found?

getAwPfromBathy

Bathymetry interpreter

getCatalogue

BaM catalogue

getComponents

Get Inference Components

getInitPar

Get initial values

getNames

Get object names

getParNames

Get parameter names

is.dataset

dataset tester

is.mcmcCooking

mcmcCooking tester

is.mcmcOptions

mcmcOptions tester

is.mcmcSummary

mcmcSummary tester

is.model

model tester

is.parameter_VAR

parameter_VAR tester

is.parameter

parameter tester

is.prediction

prediction tester

is.remnantErrorModel

remnantErrorModel tester

is.residualOptions

residualOptions tester

is.runOptions

runOptions tester

is.xtraModelInfo

xtraModelInfo tester

llfunk_iid_Gaussian

Log-likelihood function: iid Gaussian

llfunk_iLinear_Gaussian

Log-likelihood function: independent-linear Gaussian

logLikelihood_BaM

BaM log-likelihood

logPosterior_BaM_wrapped

BaM log-posterior

logPosterior_BaM

BaM log-posterior

logPrior_Flat

Log-prior function: improper flat prior

MCMC_AM

Adaptive Metropolis sampler

MCMC_OAAT

Adaptive One-At-A-Time Metropolis sampler

mcmcCooking

mcmcCooking constructor.

mcmcOptions

mcmcOptions object constructor.

mcmcSummary

mcmcSummary constructor.

model

model object constructor.

parameter_VAR

Varying parameter object constructor.

parameter

parameter object constructor.

prediction

prediction object constructor.

quickWrite

Write a character vector (typically output of toString() to file)

readMCMC

MCMC Reader

remnantErrorModel

remnantErrorModel object constructor.

residualOptions

residualOptions constructor.

runExe

Run BaM executable

runModel

Run Model

runOptions

runOptions constructor.

setInitPar

Set initial values

setPathToBaM

Path to BaM

SPD_estimate

Estimation of a BaRatin-SPD model

SPD_getVARproperties

Properties of VAR parameters

toString_engine

Write value-comment pairs into string vector

toString.dataset

dataset to string

toString.mcmcCooking

mcmcCooking to string

toString.mcmcOptions

mcmcOptions to string

toString.mcmcSummary

mcmcSummary to string

toString.model

model to string

toString.parameter_VAR

parameter_VAR to string

toString.parameter

parameter to string

toString.prediction

prediction to string

toString.remnantErrorModel

remnantErrorModel to string

toString.residualOptions

residualOptions to string

toString.runOptions

runOptions to string

tracePlot

MCMC reporting

violinPlot

violinPlot

writePredInputs

Write prediction inputs

xtraModelInfo

xtraModelInfo constructor.

An interface to the 'BaM' (Bayesian Modeling) engine, a 'Fortran'-based executable aimed at estimating a model with a Bayesian approach and using it for prediction, with a particular focus on uncertainty quantification. Classes are defined for the various building blocks of 'BaM' inference (model, data, error models, Markov Chain Monte Carlo (MCMC) samplers, predictions). The typical usage is as follows: (1) specify the model to be estimated; (2) specify the inference setting (dataset, parameters, error models...); (3) perform Bayesian-MCMC inference; (4) read, analyse and use MCMC samples; (5) perform prediction experiments. Technical details are available (in French) in Renard (2017) <https://hal.science/hal-02606929v1>. Examples of applications include Mansanarez et al. (2019) <doi:10.1029/2018WR023389>, Le Coz et al. (2021) <doi:10.1002/hyp.14169>, Perret et al. (2021) <doi:10.1029/2020WR027745>, Darienzo et al. (2021) <doi:10.1029/2020WR028607> and Perret et al. (2023) <doi:10.1061/JHEND8.HYENG-13101>.

  • Maintainer: Benjamin Renard
  • License: GPL-3
  • Last published: 2026-01-08