searchIndividuals: searchIndividuals function
In labbcb/GA4GHclient: A Bioconductor package for accessing GA4GH API data servers

Description Usage Arguments Details Value References See Also Examples

This function gets individuals matching the search criteria.

1 2	searchIndividuals(host, datasetId, name = NA_character_, nrows = Inf, responseSize = NA_integer_)

`host`	URL of GA4GH API data server.
`datasetId`	Id of the dataset to search.
`name`	Returns Individuals with the given name found by case-sensitive string matching.
`nrows`	Number of rows of the data frame returned by this function. If not defined, the function will return all entries. If the number of available entries is less than the value of this this parameter, the function will silently return only the available entries.
`responseSize`	Specifies the number of entries to be returned by the server until reach the number of rows defined in `nrows` parameter or until get all available entries. If not defined, the server will return the allowed maximum reponse size. Increasing this the value of this parameter will reduce the number of requests and reducing the time required. The will not respect this parameter if the value if larger than its maximum response size.

This function requests to /individuals/search.

DataFrame object. NULL means no registry found.

Official documentation.

DataFrame, getIndividual

host <- "http://1kgenomes.ga4gh.org/"
## Not run: 
datasetId <- searchDatasets(host, nrows = 1)$id
searchIndividuals(host, datasetId, nrows = 10)

## End(Not run)