Skip to contents

abc_fit S3 class

Source: R/s3-abc_fit-class.R
abc_fit.Rd

A class holding the output of a single ABC model fitting, either as a single ABC rejection round or after a set of SMC waves.

Usage

new_abc_fit(type, iterations, converged, priors_list, wave_df, summ_df, sim_df)

# S3 method for class 'abc_fit'
format(x, ...)

# S3 method for class 'abc_fit'
summary(object, ..., truth = NULL)

tidy.abc_fit(x, ...)

# S3 method for class 'abc_fit'
print(x, ...)

# S3 method for class 'abc_fit'
plot(x, ..., truth = NULL)

Arguments

type

the type of ABC algorithm

iterations

number of completed iterations

converged

boolean - did the result meet convergence criteria

priors_list

a named list of priors specified as a abc_prior S3 object (see priors()), this can include derived values as unnamed 2-sided formulae, where the LHS of the formula will be assigned to the value of the RHS, plus optionally a set of constraints as one sided formulae where the RHS of the formulae will resolve to a boolean value.

wave_df

a list of dataframes of wave convergence metrics

summ_df

the summary of the parameter fits after each wave.

sim_df

the final wave posteriors

x

a abc_fit object as output by the abc_XXX functions

...

passed on to methods Named arguments passed on to plot.dist_fns_list

mapping

override default aesthetics with name, id or group

steps

resolution of the plot

tail

the minimum tail probability to plot

plot_quantiles

by default the quantiles of the distribution are plotted over the density sometimes this makes it hard to read

smooth

by default some additional smoothing is used to cover up small discontinuities in the PDF.

object

a abc_fit object as output by the abc_XXX functions

truth

a named numeric vector of known parameter values

Value

an S3 object of class abc_fit this contains the following:

  • type: the type of ABC algorithm

  • iterations: number of completed iterations

  • converged: boolean - did the result meet convergence criteria

  • waves: a list of dataframes of wave convergence metrics

  • summary: a dataframe with the summary of the parameter fits after each wave.

  • priors: the priors for the fit as a abc_prior S3 object

  • posteriors: the final wave posteriors

Methods (by generic)

  • format(abc_fit): S3 format method

  • summary(abc_fit): S3 summary method

  • print(abc_fit): S3 print method

  • plot(abc_fit): S3 plot method

Functions

  • new_abc_fit(): Create a abc_fit object

  • tidy.abc_fit(): S3 summary method