sendRequest: Get one page of search results for a particular endpoint from...

Description Usage Arguments Value Examples

Description

In general, use higher level methods such as getReads and getVariants instead.

Usage

1
sendRequest(base_url, endpoint, method, body, query_fields, pageToken)

Arguments

base_url

the base URL of the GA4GH server to which requests will be sent to.

endpoint

a endpoint such as reads, variants, variantSets, etc...

method

which method (GET/POST) should be used in the request to the API?

body

The body of the message to GET/POST to the endpoint.

query_fields

The fields to be returned in the search response.

pageToken

The page token. This can be NULL for the first page.

Value

The raw response converted from JSON to an R object.

Examples

1
2
3
4
5
body <- list(readGroupSetIds=list("CMvnhpKTFhDnk4_9zcKO3_YB"),
             referenceName="22",
             start=16051400, end=16051500, pageToken=NULL)
reads <- getSearchPage("reads", body, NULL, NULL)
summary(reads)

adamstruck/ga4ghr documentation built on May 10, 2019, 5:51 a.m.