Summary method for vertex_geodesic_stats objects

Usage

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

Arguments

object: A vertex_geodesic_stats object
...: Additional arguments passed to summary

Value

A summary of the vertex geodesic statistics

Examples

x <- data.frame(
  radius = c(0.2, 0.4, 0.6),
  rays = c(3, 5, 6),
  composite_geodesics = c(1, 2, 3),
  overlap_min = c(0.10, 0.15, 0.20),
  overlap_p05 = c(0.15, 0.20, 0.25),
  overlap_p25 = c(0.20, 0.25, 0.30),
  overlap_median = c(0.30, 0.40, 0.50),
  overlap_p75 = c(0.40, 0.50, 0.60),
  overlap_p95 = c(0.55, 0.65, 0.75),
  overlap_max = c(0.60, 0.70, 0.80),
  potential_pairs = c(3, 10, 15),
  composite_ratio = c(1/3, 0.2, 0.2),
  overlap_ratio = c(0.30, 0.40, 0.50)
)
class(x) <- c("vertex_geodesic_stats", "data.frame")
attr(x, "vertex") <- 7L

summary(x)
#> Geodesic Statistics for Vertex 7 
#> 
#> Radius range: 0.2 to 0.6 
#> Number of rays: 3 to 6 
#> Number of composite geodesics: 6 
#> Average composite ratio: 0.2444444 
#> Average overlap ratio: 0.4 
#> 
#>   radius rays composite comp_ratio overlap
#> 1    0.2    3         1     0.3333     0.3
#> 2    0.4    5         2     0.2000     0.4
#> 3    0.6    6         3     0.2000     0.5