run_MCMC: Adaptive Metropolis-within-Gibbs/Metropolis Hastings Random...

View source: R/mcmc.R

run_MCMCR Documentation

Adaptive Metropolis-within-Gibbs/Metropolis Hastings Random Walk Algorithm.


The Adaptive Metropolis-within-Gibbs algorithm. Given a starting point and the necessary MCMC parameters as set out below, performs a random-walk of the posterior space to produce an MCMC chain that can be used to generate MCMC density and iteration plots. The algorithm undergoes an adaptive period, where it changes the step size of the random walk for each parameter to approach the desired acceptance rate, popt. The algorithm then uses univ_proposal or mvr_proposal to explore parameter space, recording the value and posterior value at each step. The MCMC chain is saved in blocks as a .csv file at the location given by filename. This version of the algorithm is also designed to explore posterior densities for infection histories. See the package vignettes for examples.


  antigenic_map = NULL,
  strain_isolation_times = NULL,
  mcmc_pars = c(),
  mvr_pars = NULL,
  start_inf_hist = NULL,
  filename = "test",
  CREATE_POSTERIOR_FUNC = create_posterior_func,
  version = 1,
  mu_indices = NULL,
  measurement_indices = NULL,
  measurement_random_effects = FALSE,
  proposal_ratios = NULL,
  OPT_TUNING = 0.1,
  temp = 1,
  solve_likelihood = TRUE,
  n_alive = NULL,



The parameter table controlling information such as bounds, initial values etc. See example_par_tab


The data frame of titre data to be fitted. Must have columns: group (index of group); individual (integer ID of individual); samples (numeric time of sample taken); virus (numeric time of when the virus was circulating); titre (integer of titre value against the given virus at that sampling time); run (integer giving the repeated number of this titre); DOB (integer giving date of birth matching time units used in model). See example_titre_dat


(optional) A data frame of antigenic x and y coordinates. Must have column names: x_coord; y_coord; inf_times. See example_antigenic_map


(optional) If no antigenic map is specified, this argument gives the vector of times at which individuals can be infected


Named vector named vector with parameters for the MCMC procedure. See details


Leave NULL to use univariate proposals. Otherwise, a list of parameters if using a multivariate proposal. Must contain an initial covariance matrix, weighting for adapting cov matrix, and an initial scaling parameter (0-1)


Infection history matrix to start MCMC at. Can be left NULL. See example_inf_hist


The full filepath at which the MCMC chain should be saved. "_chain.csv" will be appended to the end of this, so filename should have no file extensions


Pointer to posterior function used to calculate a likelihood. This will probably be create_posterior_func


User function of prior for model parameters. Should take parameter values only


which infection history assumption version to use? See describe_priors for options. Can be 1, 2, 3 or 4


optional NULL. For random effects on boosting parameter, mu. Vector of indices of length equal to number of circulation times. If random mus are included in the parameter table, this vector specifies which mu to use for each circulation year. For example, if years 1970-1976 have unique boosting, then mu_indices should be c(1,2,3,4,5,6). If every 3 year block shares has a unique boosting parameter, then this should be c(1,1,1,2,2,2)


optional NULL. For measurement bias function. Vector of indices of length equal to number of circulation times. For each year, gives the index of parameters named "rho" that correspond to each time period


optional FALSE. Boolean indicating if measurement bias is a random effects term. If TRUE adds a component to the posterior calculation that calculates the probability of a set of measurement shifts "rho", given a mean and standard deviation


optional NULL. Can set the relative sampling weights of the infection state times. Should be an integer vector of length matching nrow(antigenic_map). Otherwise, leave as NULL for uniform sampling.


Constant describing the amount of leeway when adapting the proposals steps to reach a desired acceptance rate (ie. does not change step size if within OPT_TUNING of the specified acceptance rate)


Temperature term for parallel tempering, raises likelihood to this value. Just used for testing at this point


if FALSE, returns only the prior and does not solve the likelihood. Use this if you wish to sample directly from the prior


if not NULL, uses this as the number alive for the infection history prior, rather than calculating the number alive based on titre_dat


Other arguments to pass to CREATE_POSTERIOR_FUNC


The mcmc_pars argument has the following options:

  • iterations (number of post adaptive period iterations to run)

  • adaptive_period (for this many iterations, change proposal step size adaptively every opt_freq iterations)

  • opt_freq (adapt proposal step size every opt_freq iterations)

  • thin (save every n iterations)

  • thin_hist (infection history thinning)

  • hist_sample_prob (proportion of individuals resampled at each iteration)

  • save_block (after this many iterations (post thinning), save to disk)

  • popt (desired acceptance rate for parameters)

  • popt_hist (desired acceptance rate for infection histories)

  • switch_sample (ratio of infection history samples to theta samples ie. switch_sample = 2 means sample inf hist twice for every theta sample, switch_sample = 0.5 means sample theta twice for every inf hist sample)

  • inf_propn (proportion of infection times to resample for each individual at each iteration)

  • move_size (number of infection years/months to move when performing infection history swap step)

  • hist_opt (if 1, performs adaptive infection history proposals. If 0, retains the starting infection history proposal parameters. This should ONLY be turned on for prior version 2)

  • swap_propn (if using gibbs sampling of infection histories, what proportion of proposals should be swap steps)

  • hist_switch_prob (proportion of infection history proposal steps to swap year_swap_propn of two time periods' contents)

  • year_swap_propn (when swapping contents of two time points, what proportion of individuals should have their contents swapped)


A list with: 1) relative file path at which the MCMC chain is saved as a .csv file; 2) relative file path at which the infection history chain is saved as a .csv file; 3) the last used covariance matrix if mvr_pars != NULL; 4) the last used scale/step size (if multivariate proposals) or vector of step sizes (if univariate proposals)

See Also

Other mcmc: generate_start_tab(), rm_scale(), save_infection_history_to_disk(), scaletuning()


## Not run: 
res <- run_MCMC(example_par_tab[example_par_tab$names != "phi",], example_titre_dat, example_antigenic_map, version=2)

## End(Not run)

seroanalytics/serosolver documentation built on April 24, 2023, 9:52 a.m.