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

View source: R/ClassFunctions.R

summary.PatternsR Documentation

Return a summary of a Patterns object

Description

Returns the below information about the object:

call of the function defining the object, the type of the pattern, parameters of the pattern, study window, some sample points from the generated pattern, reference points (if any for the bivariate pattern), and number of points for each class

Usage

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

Arguments

object

An object of class Patterns.

...

Additional parameters for summary.

Value

The call of the object of class "Patterns", the type of the pattern, parameters of the pattern, study window, some sample points from the generated pattern, reference points (if any for the bivariate pattern), and number of points for each class

See Also

print.Patterns, print.summary.Patterns, and plot.Patterns

Examples

## Not run: 
nx<-10; #try also 10, 100, and 1000
ny<-5; #try also 1
e<-.15;
Y<-cbind(runif(ny),runif(ny))
#with default bounding box (i.e., unit square)

Xdt<-rseg.circular(nx,Y,e)
Xdt
summary(Xdt)

## End(Not run)


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