search_references: Search for References

Description Usage Arguments Examples

View source: R/search.R

Description

Search for References

Usage

1
2
search_references(client, reference_set_id = NULL, accession = NULL,
  md5checksum = NULL, page_size = NULL, page_token = NULL)

Arguments

client

A ga4gh_client object

reference_set_id

The ID of the Reference Set to search within

accession

Return the References for which the accession matches this string (case-sensitive, exact match).

md5checksum

Return the References for which the md5checksum matches this string (case-sensitive, exact match).

page_size

Specifies the maximum number of results to return in a single page. If unspecified, the client default will be used.

page_token

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
ref_client <- ga4gh_client("http://1kgenomes.ga4gh.org", api_location = "")

## Not run: 
library(magrittr)
## Find a reference set to search in
reference_sets <- ref_client %>% search_reference_sets() %>% content()
rs_id <- reference_sets$referenceSets[[1]]$id

## Search for references in the reference set
references <- ref_client %>% search_references(rs_id) %>% content()
references

## End(Not run)

Rga4gh documentation built on May 29, 2017, 9:12 a.m.