Apply Filter

Source: R/Filters.R

Run an existing filter by supplying the filter name.

applyFilter(
  filter.name = "Default filter",
  hide = FALSE,
  network = NULL,
  base.url = .defaultBaseUrl
)

Arguments

filter.name

Name of filter to apply. Default is "Default filter".
hide

Whether to hide filtered out nodes and edges. Default is FALSE. Ignored if all nodes or edges are filtered out. This is an alternative to filtering for node and edge selection.
network

(optional) Name or SUID of the network. Default is the "current" network active in Cytoscape.
base.url

(optional) Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://localhost:1234 and the latest version of the CyREST API supported by this version of RCy3.

Value

List of selected nodes and edges.

Details

Known bug: selection (or hiding) of edges using edge-based column filters does not work. As a workaround, simply repeat the createColumnFilter operation to perform selection (or hiding) of edges.

See also

unhideAll

Examples

# \donttest{
applyFilter('myFilter')
applyFilter('myFilter', hide = TRUE)
# }