get_collection: Get a collection of networks

In mangal-wg/rmangal: 'Mangal' Client

Get a collection of networks

Description

Retrieve a set of networks based on the results of one of the ⁠search_*()⁠ function. The function also accepts a numeric vector of Mangal network IDs.

Usage

get_collection(x, ...)

## Default S3 method:
get_collection(x, ...)

## S3 method for class 'mgSearchDatasets'
get_collection(x, ...)

## S3 method for class 'mgSearchNetworks'
get_collection(x, ...)

## S3 method for class 'mgSearchReferences'
get_collection(x, ...)

## S3 method for class 'mgSearchNodes'
get_collection(x, ...)

## S3 method for class 'mgSearchTaxonomy'
get_collection(x, ...)

## S3 method for class 'mgSearchInteractions'
get_collection(x, ...)

Arguments

x	numeric vector of Mangal network IDs or an object returned by by one of the ⁠search_*()⁠ functions.
...	arguments to be passed on to get_network_by_id().

Value

Returns a object of class mgNetworksCollection which is a collection (actually, a list) of mgNetwork objects get_network_by_id()).

Methods (by class)

• get_collection(default): Get a collection of networks (default).

• get_collection(mgSearchDatasets): Get a collection of networks from a mgSearchDatasets object.

• get_collection(mgSearchNetworks): Get a collection of networks from a mgSearchNetworks object.

• get_collection(mgSearchReferences): Get a collection of networks from a mgSearchReferences object.

• get_collection(mgSearchNodes): Get a collection of networks from a mgSearchNodes object.

• get_collection(mgSearchTaxonomy): Get a collection of networks from a mgSearchTaxa object.

• get_collection(mgSearchInteractions): Get a collection of networks from a mgSearchTaxa object.

See Also

search_datasets(), search_interactions(), search_networks(), search_nodes(), search_references(), search_taxonomy().

Examples

 mg_2 <- get_collection(c(1076:1077), verbose = FALSE)
 mg_anemone <- get_collection(search_networks(query='anemone%'), verbose = FALSE)

mangal-wg/rmangal documentation built on Jan. 15, 2024, 10:23 p.m.