opts_dist: Constructive options for class 'dist'

View source: R/s3-dist.R

opts_distR Documentation

Constructive options for class 'dist'

Description

These options will be used on objects of class 'dist'.

Usage

opts_dist(constructor = c("as.dist", "next"), ...)

Arguments

constructor

String. Name of the function used to construct the object, see Details section.

...

Additional options used by user defined constructors through the opts object

Details

Depending on constructor, we construct the object as follows:

  • "as.dist" (default): We build the object using as.dist() on a symmetric matrix. The "call" attribute, and the "method" attribute set by dist(), are then repaired.

  • "next" : Use the constructor for the next supported class. Call .class2() on the object to see in which order the methods will be tried. This will usually be equivalent to opts_atomic().

Value

An object of class <constructive_options/constructive_options_dist>


constructive documentation built on Oct. 22, 2026, 5:07 p.m.