searchReferenceSets: searchReferenceSets function

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

Description

Search for reference sets (reference genomes).

Usage

searchReferenceSets(host, md5checksum = NA_character_,
  accession = NA_character_, assemblyId = NA_character_, nrows = Inf,
  responseSize = NA_integer_)

Arguments

host	URL of GA4GH API data server.
md5checksum	If unset, return the reference sets for which the md5checksum matches this string (case-sensitive, exact match). See ReferenceSet::md5checksum for details.
accession	If unset, return the reference sets for which the accession matches this string (case-sensitive, exact match).
assemblyId	If unset, return the reference sets for which the assemblyId matches this string (case-sensitive, exact match).
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 POST host/references/search.

Value

DataFrame object.

References

Official documentation.

See Also

DataFrame, getReferenceSet

Examples

host <- "http://1kgenomes.ga4gh.org/"
## Not run: 
searchReferenceSets(host)

## End(Not run)

labbcb/GA4GHclient documentation built on May 20, 2019, 7:32 p.m.