cograph (version 2.0.0)

filter_edges: Filter Edges by Metadata

Description

Filter edges using dplyr-style expressions on any edge column. Returns a cograph_network object by default (universal format), or optionally the same format as input when keep_format = TRUE.

Usage

filter_edges(
  x,
  ...,
  .keep_isolates = FALSE,
  keep_format = FALSE,
  directed = NULL
)
subset_edges(
  x,
  ...,
  .keep_isolates = FALSE,
  keep_format = FALSE,
  directed = NULL
)

Value

A cograph_network object with filtered edges. If keep_format = TRUE, returns the same type as input (matrix, igraph, network, etc.).

See filter_edges.

Arguments

x

Network input: cograph_network, matrix, igraph, network, or tna object.

...

Filter expressions using any edge column (e.g., weight > 0.5, weight > mean(weight), abs(weight) > 0.3).

.keep_isolates

Logical. Keep nodes with no remaining edges? Default FALSE.

keep_format

Logical. If TRUE, return the same format as input (matrix returns matrix, igraph returns igraph, etc.). Default FALSE returns cograph_network (universal format).

directed

Logical or NULL. If NULL (default), auto-detect from matrix symmetry. Set TRUE to force directed, FALSE to force undirected. Only used for non-cograph_network inputs.

See Also

filter_nodes, splot, subset_edges

Examples

adj <- matrix(c(0, .5, .8, 0,
                .5, 0, .3, .6,
                .8, .3, 0, .4,
                 0, .6, .4, 0), 4, 4, byrow = TRUE)
rownames(adj) <- colnames(adj) <- c("A", "B", "C", "D")

# Keep only strong edges (returns cograph_network)
filter_edges(adj, weight > 0.5)

# Keep format: matrix in, matrix out
filter_edges(adj, weight > 0.5, keep_format = TRUE)

# Keep edges above mean weight
splot(filter_edges(adj, weight >= mean(weight)))

# With cograph_network (pipe-friendly)
net <- as_cograph(adj)
net |>
  filter_edges(weight > 0.3) |>
  filter_nodes(degree >= 2) |>
  splot()

# Keep isolated nodes
filter_edges(net, weight > 0.7, .keep_isolates = TRUE)

# With igraph (keep_format = TRUE returns igraph)
if (requireNamespace("igraph", quietly = TRUE)) {
  g <- igraph::make_ring(5)
  filter_edges(g, weight > 0, keep_format = TRUE)  # Returns igraph
}