filter_edges: Filter Edges by Metadata

View source: R/network-utils.R

filter_edgesR Documentation

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 a matrix, igraph, statnet network or tna object when keep_format = TRUE and the input used one of those formats.

Usage

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

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

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 that end up with no edges? Default TRUE, matching igraph::delete_edges() and tidygraph: filtering edges does not remove nodes. Set FALSE to drop them, or call remove_isolates() afterwards.

keep_format

Logical. If TRUE, matrix, igraph, statnet network and tna inputs are returned in that format. 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.

.keep_isolates

Deprecated. Use keep_isolates.

Value

A cograph_network object with filtered edges. If keep_format = TRUE, matrix, igraph, statnet network and tna inputs are converted back to that type. With keep_isolates = TRUE, a node that loses all its edges stays in the network and a cograph_isolates_created warning is raised.

See Also

filter_nodes, splot, subset_edges

Examples

filter_edges(regulation_net, weight > 0.15)

cograph documentation built on Nov. 19, 2026, 5:07 p.m.