Skip to contents

This class represents a conjugate Gaussian model (Gaussian prior and Gaussian likelihood)

Super class

Model -> GaussianConjugate

Public fields

prior_mean

Prior mean

prior_var

Prior variance

empirical_bayes

Whether the method relies on empirical Bayes or not

post_mean

Posterior mean

post_var

Posterior variance

posterior_parameters

Posterior parameters

Methods

Inherited methods


GaussianConjugate$new()

Initialize object from the GaussianConjugate class

Usage

Arguments

prior

Prior


GaussianConjugate$sample_prior()

Sample from the prior

Usage

GaussianConjugate$sample_prior(n_samples)

Arguments

n_samples

Number of samples from the prior


GaussianConjugate$sample_posterior()

Sample from the posterior

Usage

GaussianConjugate$sample_posterior(n_samples)

Arguments

n_samples

Number of samples from the posterior


GaussianConjugate$prior_pdf()

Prior PDF

Usage

GaussianConjugate$prior_pdf(target_treatment_effect)

Arguments

target_treatment_effect

Point at which to evaluate the prior PDF


GaussianConjugate$prior_cdf()

Prior CDF

Usage

GaussianConjugate$prior_cdf(target_treatment_effect)

Arguments

target_treatment_effect

Point at which to evaluate the prior CDF


GaussianConjugate$posterior_cdf()

Posterior CDF

Usage

GaussianConjugate$posterior_cdf(target_treatment_effect)

Arguments

target_treatment_effect

Point at which to evaluate the posterior CDF


GaussianConjugate$posterior_pdf()

Posterior PDF

Usage

GaussianConjugate$posterior_pdf(target_treatment_effect)

Arguments

target_treatment_effect

Point at which to evaluate the posterior PDF


GaussianConjugate$posterior_mean()

Posterior mean

Usage

GaussianConjugate$posterior_mean(target_data)

Arguments

target_data

Target study data


GaussianConjugate$posterior_variance()

Posterior variance

Usage

GaussianConjugate$posterior_variance(target_data)

Arguments

target_data

Target study data


GaussianConjugate$posterior_moments()

Posterior moments

Usage

GaussianConjugate$posterior_moments(target_data)

Arguments

target_data

Target study data


GaussianConjugate$vectorised_replicate_inference()

Run every replicate at once

The prior is a single normal, so the posterior is available in closed form for all replicates simultaneously. Empirical Bayes subclasses re-derive the prior variance from each replicate; they supply it through vectorised_prior_variance().

Usage

GaussianConjugate$vectorised_replicate_inference(
  target_data,
  samples,
  to_return,
  critical_value,
  theta_0,
  confidence_level,
  null_space
)

Arguments

target_data

Target study data.

samples

Data frame of generated replicates.

to_return

Character vector of requested outputs.

critical_value

Critical value for hypothesis testing.

theta_0

Null hypothesis value.

confidence_level

Confidence level for the credible interval.

null_space

The null space for hypothesis testing.

Returns

A list of simulation results, or NULL to use the replicate loop.


GaussianConjugate$vectorised_prior_variance()

Prior variance for each replicate

Declines the vectorised path by default. Subclasses with a genuinely fixed prior return it, and empirical Bayes subclasses return one variance per replicate.

Usage

GaussianConjugate$vectorised_prior_variance(target_data, samples)

Arguments

target_data

Target study data.

samples

Data frame of generated replicates.

Returns

A scalar, a vector with one entry per replicate, or NULL.


GaussianConjugate$vectorised_posterior_parameters()

Posterior parameters reported by the vectorised path

The plain conjugate models report none. Empirical Bayes subclasses override this to report the power parameter they estimated.

Usage

GaussianConjugate$vectorised_posterior_parameters(prior_variance)

Arguments

prior_variance

Per-replicate prior variance.

Returns

A data frame, or NULL.


GaussianConjugate$posterior_median()

Posterior median

Usage

GaussianConjugate$posterior_median(...)

Arguments

...

Additional argument

Returns

The posterior median


GaussianConjugate$credible_interval()

Credible interval

Usage

GaussianConjugate$credible_interval(level = 0.95)

Arguments

level

Level of the credible interval


GaussianConjugate$prior_to_RBesT()

Convert the prior to RBesT format

Usage

GaussianConjugate$prior_to_RBesT(...)

Arguments

...

Additional arguments


GaussianConjugate$posterior_to_RBesT()

Convert the posterior distribution to RBesT format

Usage

GaussianConjugate$posterior_to_RBesT(target_data, ...)

Arguments

target_data

Target study data

...

Additional arguments


GaussianConjugate$clone()

The objects of this class are cloneable with this method.

Usage

GaussianConjugate$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.