ndex_find_groups: Search groups in NDEx
In frankkramer-lab/ndexr: NDEx R client library

ndex_find_groups

R Documentation

Search groups in NDEx

Description

Returns a SearchResult object which contains an array of Group objects

Usage

ndex_find_groups(ndexcon, searchString = "", start, size)

Arguments

`ndexcon`	object of class NDExConnection linkndex_connect
`searchString`	string by which to search
`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 group information; NULL if no groups are found.

REST query

GET: ndex_config$api$search$user

Note

Compatible to NDEx server version 1.3 and 2.0

Search strings may be structured

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Find a group
groups = ndex_find_groups(ndexcon,"Ideker Lab")
names(groups)
## [1] "properties"  "groupName"  "image"             "website"       "description"
## [6] "externalId"  "isDeleted"  "modificationTime"  "creationTime"

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