Prior-Covariance Arguments For mr.mash

Settings for buildMrmashPriorMatrices, the shared prior-covariance builder behind mrmashWrapper and mrmashRssWeights.

The builder reaches two mr.mashr functions, so the arguments bound for each travel in their own nested bundle — canonicalCovs for compute_canonical_covs() and expandCovs for expand_covs() — and each is checked against that function's live formals. The two fields pecotmr itself reads stay flat.

dataDrivenPriorMatrices is not set here: it is an input computed upstream (typically by mashPriorCovariances), not a tuning choice, so it stays a parameter of the caller.

Usage

MrmashPriorParam(
  canonicalPriorMatrices = FALSE,
  priorGrid = NULL,
  canonicalCovs = MrmashCanonicalCovsOptions(),
  expandCovs = MrmashExpandCovsOptions()
)

Arguments

canonicalPriorMatrices

Logical. Include the canonical mixture from mr.mashr::compute_canonical_covs(). Default FALSE.

priorGrid

Optional pre-computed scaling grid (numeric vector). NULL (default) derives one from the summary statistics via computeGrid().

canonicalCovs

Arguments for mr.mashr::compute_canonical_covs(), built with MrmashCanonicalCovsOptions. Only consulted when canonicalPriorMatrices is TRUE.

expandCovs

Arguments for mr.mashr::expand_covs(), built with MrmashExpandCovsOptions.

Value

A MrmashPriorParam object, a MethodParam.

Examples

MrmashPriorParam(canonicalPriorMatrices = TRUE)
#> <MrmashPriorParam>
#>   canonicalPriorMatrices   TRUE
#>   canonicalCovs            <mrmashCanonicalCovs: defaults>
#>   expandCovs               <mrmashExpandCovs: defaults>
#>   unset: priorGrid
MrmashPriorParam(
    canonicalCovs = MrmashCanonicalCovsOptions(singletons = FALSE)
)
#> <MrmashPriorParam>
#>   canonicalPriorMatrices   FALSE
#>   canonicalCovs            <mrmashCanonicalCovs: singletons>
#>   expandCovs               <mrmashExpandCovs: defaults>
#>   unset: priorGrid