1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/get_mean_distance.R
3\name{get_mean_distance}
4\alias{get_mean_distance}
5\title{Get the mean distance}
6\usage{
7get_mean_distance(graph)
8}
9\arguments{
10\item{graph}{A graph object of class \code{dgr_graph}.}
11}
12\value{
13A single numeric value representing the mean distance of the graph.
14}
15\description{
16Get the mean distance of a graph, which is the average path length in the
17graph. This operates through calculation of the shortest paths between all
18pairs of nodes.
19}
20\examples{
21# Create a cycle graph
22graph <-
23  create_graph() \%>\%
24  add_cycle(n = 5)
25
26# Determine the mean distance
27graph \%>\%
28  get_mean_distance()
29
30# Create a full graph and then
31# get the mean distance value
32create_graph() \%>\%
33  add_full_graph(n = 10) \%>\%
34  get_mean_distance()
35
36}
37