File: isAdjacent-methods.Rd

package info (click to toggle)
r-bioc-graph 1.60.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,076 kB
  • sloc: ansic: 842; makefile: 12; sh: 3
file content (28 lines) | stat: -rw-r--r-- 860 bytes parent folder | download | duplicates (6)
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
\name{isAdjacent-methods}
\docType{methods}
\alias{isAdjacent-methods}
\alias{isAdjacent}

\title{Determine if nodes share an edge in a graph}

\usage{
isAdjacent(object, from, to, ...)
}
\arguments{
  \item{object}{An instance of a subclass of \code{\link{graph-class}}.}
  \item{from}{A \code{character} vector of nodes in the graph.}
  \item{to}{A \code{character} vector of nodes in the graph}
  \item{...}{May be used by methods called on subclasses of \code{graph}}
}

\description{
  For a given subclass of \code{graph-class}, returns \code{TRUE} if the
  graph contains an edge from node specified by \code{from} to the node
  specified by \code{to}.

  The appropriate logical vector will be returned as long as \code{from}
  and \code{to} have the same length and contain nodes in the graph
  object specified by \code{object}.
}
\keyword{methods}