cograph (version 2.7.2)

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 a matrix, igraph, or statnet network 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
)

Value

A cograph_network object with filtered edges. If keep_format = TRUE, matrix, igraph, and statnet network inputs are converted back to that type. Nodes are never removed by the filter itself; when the filter strands a node a cograph_isolates_created warning is raised.

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 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, and statnet network 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.

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
filter_edges(adj, weight > 0.5)

# Matrix in, matrix out
filter_edges(adj, weight > 0.5, keep_format = TRUE)

# Pipe-friendly with cograph_network
as_cograph(adj) |>
  filter_edges(weight > 0.3) |>
  filter_nodes(degree >= 2) |>
  splot()