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

View source: R/ClassFunctions.R

summary.PCDsR Documentation

Return a summary of a PCDs object

Description

Returns the below information about the object:

call of the function defining the object, the type of the proximity catch digraph (PCD), (i.e. the description of the PCD), some of the partition (i.e. intervalization in the 1D case and triangulation in the 2D case) points (i.e., vertices of the intervals or the triangles), parameter(s) of the PCD, and various quantities (number of vertices, number of arcs and arc density of the PCDs, number of vertices for the partition and number of partition cells (i.e., intervals or triangles)).

Usage

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

Arguments

object

An object of class PCDs.

...

Additional parameters for summary.

Value

The call of the object of class "PCDs", the type of the proximity catch digraph (PCD), (i.e. the description of the PCD), some of the partition (i.e. intervalization in the 1D case and triangulation in the 2D case) points (i.e., vertices of the intervals or the triangles), parameter(s) of the PCD, and various quantities (number of vertices, number of arcs and arc density of the PCDs, number of vertices for the partition and number of partition cells (i.e., intervals or triangles)).

See Also

print.PCDs, print.summary.PCDs, and plot.PCDs

Examples

## Not run: 
A<-c(1,1); B<-c(2,0); C<-c(1.5,2);
Tr<-rbind(A,B,C);
n<-10
Xp<-runif.tri(n,Tr)$g
M<-as.numeric(runif.tri(1,Tr)$g)
Arcs<-arcsAStri(Xp,Tr,M)
Arcs
summary(Arcs)

## End(Not run)


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