ndex_find_networks: Search networks in NDEx (by description)

View source: R/ndex_networks.r

ndex_find_networksR Documentation

Search networks in NDEx (by description)

Description

This functions searches the public networks on an NDEx server for networks containing the supplied search string. T his search can be limited to certain accounts as well as in length.

Usage

ndex_find_networks(ndexcon, searchString = "", accountName, start, size)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

searchString

string by which to search

accountName

string (optional); constrain search to networks administered by this account

start

integer (optional); specifies that the result is the nth page of the requested data. The default value is 0

size

integer (optional); specifies the number of data items in each page. The default value is 100

Value

Data frame with network information: ID, name, whether it is public, edge and node count; source and format of network. NULL if no networks are found.

REST query

GET: ndex_config$api$search$network$search

Note

Compatible to NDEx server version 1.3 and 2.0

Search strings may be structured

Examples

ndexcon = ndex_connect()
networks = ndex_find_networks(ndexcon,"p53") 

frankkramer-lab/ndexr documentation built on April 4, 2023, 7:19 p.m.