compare: Comparison multiple 'prcalc', 'prcalc_index', or...

View source: R/compare.R

compareR Documentation

Comparison multiple prcalc, prcalc_index, or prcalc_decomposition objects.

Description

Comparison multiple prcalc, prcalc_index, or prcalc_decomposition objects.

Usage

compare(x, ...)

## S3 method for class 'list'
compare(x, prop = FALSE, ...)

Arguments

x

a list. All elements in the list must be prcalc, prcalc_index, or prcalc_decomposition objects.

...

Ignored

prop

Default is FALSE.

Value

A prcalc_compare, prcalc_index_compare, or prcalc_decomposition_compare object

Examples

data(jp_upper_2019)

pr_obj1 <- prcalc(jp_upper_2019, m = 50, method = "dt")
pr_obj2 <- prcalc(jp_upper_2019, m = 50, method = "dt", threshold = 0.025)
pr_obj3 <- prcalc(jp_upper_2019, m = 50, method = "dt", threshold = 0.05)

compare(list("t = 0%" = pr_obj1, "t = 2.5%" = pr_obj2, "t = 5%" = pr_obj3))

list("t = 0%"   = index(pr_obj1),
     "t = 2.5%" = index(pr_obj2),
     "t = 5%"   = index(pr_obj3)) |>
  compare()

JaehyunSong/PRcalc documentation built on April 17, 2024, 1:23 p.m.