Skip to contents

Summarize a nested sampling run

Source: R/run-class.R
summary.ernest_run.Rd

Provides a summary of an ernest_run object, including key statistics and a tibble of results for each iteration.

Usage

# S3 method for class 'ernest_run'
summary(object, ...)

Arguments

object

An ernest_run object.

...

These dots are for future extensions and must be empty.

Value

A list of class summary.ernest_run with the following components:

  • n_iter: Integer. Number of iterations performed.

  • n_points: Integer. Number of live points used in the run.

  • n_calls: Integer. Total number of likelihood function calls.

  • log_volume: Double. Final estimated log-prior volume.

  • log_evidence: Double. Final log-evidence estimate.

  • log_evidence_err: Double. Standard deviation of the log-evidence estimate.

  • draws: Posterior draws as returned by as_draws().

  • run A tibble::tibble.

run stores the state of the run at each iteration with these columns:

  • call: Cumulative number of likelihood calls.

  • log_lik: Log-likelihood for each sample.

  • log_volume: Estimated log-prior volume.

  • log_weight: Unnormalized log-weights (relative to evidence).

  • log_evidence: Cumulative log-evidence.

  • log_evidence_err: Standard deviation of log-evidence.

  • information: Estimated KL divergence at each iteration.

See also

Examples

# Load an example run
data(example_run)

# Summarize the run and view a tibble of its results.
run_sm <- summary(example_run)
run_sm
#> nested sampling result summary <summary.ernest_run>
#> • No. Points: 1000
#> • No. Iterations: 9398
#> ────────────────────────────────────────────────────────────────────────────────
#> • No. Calls: 205628
#> • Log. Volume: -16.88
#> • Log. Evidence: -9.061 (± 0.08303)
run_sm$run
#> # A tibble: 10,398 × 7
#>     call log_lik log_volume log_weight log_evidence log_evidence_err information
#>    <int>   <dbl>      <dbl>      <dbl>        <dbl>            <dbl>       <dbl>
#>  1     1   -147.     -0.001      -145.        -154.         7.07e-33   -5.00e-62
#>  2     2   -141.     -0.002      -139.        -148.         1.83e-31   -3.34e-59
#>  3     3   -136.     -0.003      -134.        -143.         1.87e-30   -3.48e-57
#>  4     4   -136.     -0.004      -133.        -142.         3.77e-30   -1.42e-56
#>  5     5   -134.     -0.005      -131.        -140.         8.37e-30   -7.00e-56
#>  6     6   -130.     -0.006      -128.        -137.         3.89e-29   -1.51e-54
#>  7     7   -130.     -0.007      -128.        -136.         6.89e-29   -4.75e-54
#>  8     8   -129.     -0.008      -127.        -135.         1.10e-28   -1.20e-53
#>  9     9   -129.     -0.009      -127.        -135.         1.56e-28   -2.44e-53
#> 10    10   -126.     -0.01       -123.        -132.         4.05e-28   -1.64e-52
#> # ℹ 10,388 more rows