1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/get_eccentricity.R
3\name{get_eccentricity}
4\alias{get_eccentricity}
5\title{Get node eccentricities}
6\usage{
7get_eccentricity(graph, mode = "out")
8}
9\arguments{
10\item{graph}{A graph object of class \code{dgr_graph}.}
11
12\item{mode}{the mode with which the shortest paths to or from the given
13vertices should be calculated for directed graphs. If \code{out} (the
14default) then the shortest paths from the node, if \verb{in} then only
15shortest paths to each node are considered. If \code{all} is used, then the
16corresponding undirected graph will be used and edge directions will be
17ignored. For undirected graphs, this argument is ignored.}
18}
19\value{
20A data frame containing eccentricity values by node ID value.
21}
22\description{
23Get a data frame with node eccentricity values.
24}
25\examples{
26# Create a random graph using the
27# `add_gnm_graph()` function
28graph <-
29  create_graph(
30    directed = FALSE) \%>\%
31  add_gnm_graph(
32    n = 10,
33    m = 15,
34    set_seed = 23)
35
36# Get the eccentricity values for
37# all nodes in the graph
38graph \%>\% get_eccentricity()
39
40}
41