File: graph_types.Rd

package info (click to toggle)
r-cran-tidygraph 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 736 kB
  • sloc: cpp: 35; sh: 13; makefile: 2
file content (86 lines) | stat: -rw-r--r-- 2,312 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/graph_types.R
\name{graph_types}
\alias{graph_types}
\alias{graph_is_simple}
\alias{graph_is_directed}
\alias{graph_is_bipartite}
\alias{graph_is_connected}
\alias{graph_is_tree}
\alias{graph_is_forest}
\alias{graph_is_dag}
\alias{graph_is_chordal}
\alias{graph_is_complete}
\alias{graph_is_isomorphic_to}
\alias{graph_is_subgraph_isomorphic_to}
\title{Querying graph types}
\usage{
graph_is_simple()

graph_is_directed()

graph_is_bipartite()

graph_is_connected()

graph_is_tree()

graph_is_forest()

graph_is_dag()

graph_is_chordal()

graph_is_complete()

graph_is_isomorphic_to(graph, method = "auto", ...)

graph_is_subgraph_isomorphic_to(graph, method = "auto", ...)
}
\arguments{
\item{graph}{The graph to compare structure to}

\item{method}{The algorithm to use for comparison}

\item{...}{Arguments passed on to the comparison methods. See
\code{\link[igraph:is_isomorphic_to]{igraph::is_isomorphic_to()}} and \code{\link[igraph:is_subgraph_isomorphic_to]{igraph::is_subgraph_isomorphic_to()}}}
}
\value{
A logical scalar
}
\description{
This set of functions lets the user query different aspects of the graph
itself. They are all concerned with wether the graph implements certain
properties and will all return a logical scalar.
}
\section{Functions}{
\itemize{
\item \code{graph_is_simple}: Is the graph simple (no parallel edges)

\item \code{graph_is_directed}: Is the graph directed

\item \code{graph_is_bipartite}: Is the graph bipartite

\item \code{graph_is_connected}: Is the graph connected

\item \code{graph_is_tree}: Is the graph a tree

\item \code{graph_is_forest}: Is the graph an ensemble of multiple trees

\item \code{graph_is_dag}: Is the graph a directed acyclic graph

\item \code{graph_is_chordal}: Is the graph chordal

\item \code{graph_is_complete}: Is the graph fully connected

\item \code{graph_is_isomorphic_to}: Is the graph isomorphic to another graph. See \code{\link[igraph:is_isomorphic_to]{igraph::is_isomorphic_to()}}

\item \code{graph_is_subgraph_isomorphic_to}: Is the graph an isomorphic subgraph to another graph. see \code{\link[igraph:is_subgraph_isomorphic_to]{igraph::is_subgraph_isomorphic_to()}}
}}

\examples{
gr <- create_tree(50, 4)

with_graph(gr, graph_is_tree())

}