summary.Extrema: Return a summary of a 'Extrema' 'object'

View source: R/ClassFunctions.R

summary.ExtremaR Documentation

Return a summary of a Extrema object

Description

Returns the below information about the object:

call of the function defining the object, the type of the extrema (i.e. the description of the extrema), extrema points, distances from extrema to the reference object (e.g. boundary of a triangle), some of the data points (from which extrema is found).

Usage

## S3 method for class 'Extrema'
summary(object, ...)

Arguments

object

An object of class Extrema.

...

Additional parameters for summary.

Value

The call of the object of class "Extrema", the type of the extrema (i.e. the description of the extrema), extrema points, distances from extrema to the reference object (e.g. boundary of a triangle), some of the data points (from which extrema is found).

See Also

print.Extrema, print.summary.Extrema, and plot.Extrema

Examples

## Not run: 
n<-10
Xp<-runif.std.tri(n)$gen.points
Ext<-cl2edges.std.tri(Xp)
Ext
summary(Ext)

## End(Not run)


elvanceyhan/pcds documentation built on June 29, 2023, 8:12 a.m.