1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/create_graph_series.R
3\name{create_graph_series}
4\alias{create_graph_series}
5\title{Create a graph series object}
6\usage{
7create_graph_series(
8  graph = NULL,
9  series_name = NULL,
10  series_type = "sequential"
11)
12}
13\arguments{
14\item{graph}{A graph object to add to the new graph series object.}
15
16\item{series_name}{An optional name to ascribe to the series.}
17
18\item{series_type}{Either a \code{sequential} type (the default) or a \code{temporal}
19type (which requires date-time strings and time zone codes to be supplied).}
20}
21\value{
22A graph series object of type \code{dgr_graph_1D}.
23}
24\description{
25Create a graph series object for the storage of multiple graphs across a
26sequential or temporal one-dimensional array.
27}
28\examples{
29# Create three graphs
30graph_1 <-
31  create_graph() \%>\%
32  add_path(n = 4)
33
34graph_2 <-
35  create_graph() \%>\%
36  add_cycle(n = 5)
37
38graph_3 <-
39  create_graph() \%>\%
40  add_star(n = 6)
41
42# Create an empty graph series
43# and add the graphs
44series <-
45  create_graph_series() \%>\%
46  add_graph_to_graph_series(
47    graph = graph_1) \%>\%
48  add_graph_to_graph_series(
49    graph = graph_2) \%>\%
50  add_graph_to_graph_series(
51    graph = graph_3)
52
53# Count the number of graphs
54# in the graph series
55series \%>\%
56  count_graphs_in_graph_series()
57
58}
59