1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/get_min_eccentricity.R
3\name{get_min_eccentricity}
4\alias{get_min_eccentricity}
5\title{Get the minimum graph eccentricity}
6\usage{
7get_min_eccentricity(graph, direction = "all")
8}
9\arguments{
10\item{graph}{A graph object of class \code{dgr_graph}.}
11
12\item{direction}{Using \code{all} (the default), the search will ignore edge
13direction while traversing through the graph. With \code{out}, measurements of
14paths will be from a node whereas with \verb{in}, measurements of paths will be
15to a node.}
16}
17\value{
18A single numeric value representing the minimum eccentricity of the
19graph.
20}
21\description{
22Get the radius of a graph, which is the smallest eccentricity in the graph.
23The graph eccentricity of a node is its shortest path from the farthest other
24node in the graph.
25}
26\examples{
27# Create a cycle graph
28graph <-
29  create_graph() \%>\%
30  add_cycle(n = 5)
31
32# Determine the graph's minimum
33# eccentricity
34graph \%>\%
35  get_min_eccentricity()
36
37# Create a full graph and then
38# get the minimum eccentricity
39# value for that
40create_graph() \%>\%
41  add_full_graph(n = 10) \%>\%
42  get_min_eccentricity()
43
44}
45