searchBiosamples: searchBiosamples function

Description Usage Arguments Details Value References See Also Examples

View source: R/searchBiosamples.R

Description

This function gets Biosamples matching the search criteria.

Usage

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

Arguments

host

URL of GA4GH API data server.

datasetId

Id of the dataset to search.

name

Returns Biosamples with the given name found by case-sensitive string matching.

individualId

Returns Biosamples for the provided individual ID.

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.

Details

This function requests to /biosamples/search.

Value

DataFrame object. NULL means no registry found.

References

Official documentation.

See Also

DataFrame, getBiosample

Examples

1
2
3
4
5
6
host <- "http://1kgenomes.ga4gh.org/"
## Not run: 
datasetId <- searchDatasets(host, nrows = 1)$id
searchBiosamples(host, datasetId, nrows = 10)

## End(Not run)

GA4GHclient documentation built on Nov. 1, 2018, 4:25 a.m.