SymmetricResamplingOptions: Set options for symmetric resampling

SymmetricResamplingOptionsR Documentation

Set options for symmetric resampling

Description

SymmetricResamplingOptions is an R6 class that defines parameters for symmetric resampling analyses.

Super classes

nitro::AbstractExtension -> nitro::AbstractResamplingOptions -> SymmetricResamplingOptions

Active bindings

probability

An integer value indicating the change probability.

Methods

Public methods


Method new()

Usage
SymmetricResamplingOptions$new(
  replications = 100,
  probability = 36,
  cutoff = 0,
  frequency_summary = "absolute"
)
Arguments
replications

An integer value indicating the number of resampling replications to perform.

probability

An integer value indicating the change probability.

cutoff

An integer value indicating the cutoff value for frequencies.

frequency_summary

A character vector indicating which method(s) to use to summarize supports. More than one option can be specified. The options are:

  • absolute: absolute frequencies, default;

  • difference: frequency differences (i.e., group supported/contradicted);

  • slope: frequency slopes.


Method print()

Usage
SymmetricResamplingOptions$print(...)
Arguments
...

Ignored.


Method queue()

Usage
SymmetricResamplingOptions$queue(...)
Arguments
...

Ignored.


Method clone()

The objects of this class are cloneable with this method.

Usage
SymmetricResamplingOptions$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


paravian/nitro documentation built on Jan. 17, 2025, 11:21 p.m.