search_networks: Query networks

In mangal-wg/rmangal: 'Mangal' Client

Query networks

Description

Search over all networks using a keyword, a custom query or a spatial object If the query is a character string, then all character columns in the table are searched and the entries for which at least one partial match was found are returned. Alternatively, a named list can be used to look for an exact match in a specific column (see Details section)

Usage

search_networks(query, verbose = TRUE, ...)

search_networks_sf(query_sf, verbose = TRUE, ...)

Arguments

query	either a character string including a single keyword or a named list containing a custom query (see details section below), or a spatial object (see the description of query_sf). Note that if an empty character string is passed, then all datasets available are returned.
verbose	a logical. Should extra information be reported on progress?
...	further arguments to be passed to httr::GET().
query_sf	a spatial object of class sf used to search in a specific geographical area.

Details

Names of the list should match one of the column names within the table. For the networks table, those are

• id: unique identifier of the network;

• all_interactions: false interaction can be considered as real false interaction

• dataset_id: the identifier of the dataset;

• public: network publicly available;

Note that for lists with more than one element, only the first element is used, the others are ignored. An example is provided below.

Value

An object of class mgSearchNetworks, which is a data.frame object with all networks informations

Functions

• search_networks_sf(): Search networks within a spatial object passed as an argument. Note that sf must be installed to use this function.

References

• https://mangal.io/#/

• https://mangal-interactions.github.io/mangal-api/#networks

Examples

mg_insect <- search_networks(query = "insect%")
# Retrieve the search results
nets_insect <- get_collection(mg_insect)
# Spatial query
if (requireNamespace("sf", quietly = TRUE)) {
 area <- sf::st_read(system.file("shape/nc.shp", package="sf"))
 networks_in_area <- search_networks_sf(area, verbose = FALSE)
 plot(networks_in_area)
} else warning("Package sf is missing")
# Retrieve network ID 5013
net_5013 <- search_networks(query = list(id = 5013))
# Network(s) of dataset ID 19
mg_19 <- search_networks(list(dataset_id = 19))

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