One specification of the score; the default is the Population Fidelity Score of da Silva et al. (2026)

Usage

pfs_variant(
  name = "default",
  dispersion = NULL,
  adaptability = NULL,
  structure = NULL,
  clipped = NULL,
  aggregate = NULL,
  weighted = NULL,
  round_pairs = NULL,
  based_on = NULL
)

Arguments

name: A variant name from pfs_variants(), or the name of a new variant built on based_on.
dispersion: "median" or "mean" between-cell distance.
adaptability: "symmetric" or "one_sided" ratio score.
structure: "spearman", "pearson" or "kendall".
clipped: Clip the structure correlation at zero.
aggregate: "geometric" or "arithmetic" mean of the components.
weighted: Weight cell errors by respondent counts.
round_pairs: Decimals the pairwise distances are rounded to before ranking, or NULL.
based_on: A variant name whose settings a newly named variant starts from, or NULL.

Value

A popfidelity_variant object.

Examples

pfs_variant()
#> <popfidelity_variant> default: median dispersion, symmetric adaptability, spearman clipped structure, geometric mean
pfs_variant("kendall_structure")
#> <popfidelity_variant> kendall_structure: median dispersion, symmetric adaptability, kendall clipped structure, geometric mean
pfs_variant("tied", round_pairs = 10, based_on = "default")
#> <popfidelity_variant> tied: median dispersion, symmetric adaptability, spearman clipped structure, geometric mean, pairs rounded to 10