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 results <ernest_run> ────────────────────────────────────────
#> No. Points: 500
#> No. Iterations: 4636
#> No. Lik. Calls: 101303
#> Log. Evidence: -8.932 (± 0.1143)
run_sm$run
#> # A tibble: 5,136 × 7
#>     call log_lik log_volume log_weight log_evidence log_evidence_err information
#>    <int>   <dbl>      <dbl>      <dbl>        <dbl>            <dbl>       <dbl>
#>  1     1   -146.     -0.002      -143.        -152.         2.71e-32   -3.68e-61
#>  2     2   -144.     -0.004      -141.        -150.         8.06e-32   -3.25e-60
#>  3     3   -139.     -0.006      -136.        -145.         1.03e-30   -5.32e-58
#>  4     4   -136.     -0.008      -133.        -142.         5.11e-30   -1.30e-56
#>  5     5   -129.     -0.01       -126.        -135.         1.44e-28   -1.04e-53
#>  6     6   -126.     -0.012      -124.        -133.         5.09e-28   -1.30e-52
#>  7     7   -125.     -0.014      -122.        -131.         1.19e-27   -7.03e-52
#>  8     8   -125.     -0.016      -122.        -130.         1.90e-27   -1.81e-51
#>  9     9   -118.     -0.018      -116.        -124.         2.59e-26   -3.35e-49
#> 10    10   -118.     -0.02       -115.        -124.         4.94e-26   -1.22e-48
#> # ℹ 5,126 more rows