File: valid.eids.Rd

package info (click to toggle)
r-cran-network 1.20.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,516 kB
  • sloc: ansic: 2,491; sh: 13; makefile: 2
file content (49 lines) | stat: -rw-r--r-- 1,294 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/access.R
\name{valid.eids}
\alias{valid.eids}
\alias{valid.eids.network}
\title{Get the ids of all the edges that are valid in a network}
\usage{
valid.eids(x, ...)

\method{valid.eids}{network}(x, ...)
}
\arguments{
\item{x}{a network object, possibly with some deleted edges.}

\item{...}{additional arguments to methods.}
}
\value{
a vector of integer ids corresponding to the non-null edges in x
}
\description{
Returns a vector of valid edge ids (corresponding to non-NULL edges) for a
network that may have some deleted edges.
}
\details{
The edge ids used in the network package are positional indices on the
internal "mel" list. When edges are removed using \code{\link{delete.edges}}
\code{NULL} elements are left on the list.  The function \code{valid.eids}
returns the ids of all the valid (non-null) edge ids for its \code{network}
argument.
}
\note{
If it is known that x has no deleted edges, \code{seq_along(x$mel)} is
a faster way to generate the sequence of possible edge ids.
}
\examples{

net<-network.initialize(100)
add.edges(net,1:99,2:100)
delete.edges(net,eid=5:95)
# get the ids of the non-deleted edges
valid.eids(net)

}
\seealso{
See also \code{\link{delete.edges}}
}
\author{
skyebend
}