callGRPCMethod: Issues a gRPC call to the Google Genomics service and returns...

Description Usage Arguments Details Value See Also Examples

Description

Needs gRPC support at package build time and the RProtoBuf package. See package README for instructions on installing gRPC.

Usage

1
callGRPCMethod(methodName, request)

Arguments

methodName

The RPC method name.

request

The request object for the RPC, either as a JSON object generated from rjson, or as a RProtoBuf object modified from the default instance obtained from getRProtoBufDefaultObject.

Details

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

Value

The raw response converted from JSON to an R object, or the RProtoBuf object if the request was an RProtoBuf object.

See Also

Other page fetch functions: getReadsPage, getSearchPage, getVariantsPage

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Authenticated on package load from the env variable GOOGLE_API_KEY.
if (isGRPCAvailable()) {
  request <- list(readGroupSetIds=list("CMvnhpKTFhDnk4_9zcKO3_YB"),
                  referenceName="22",
                  start=16051400, end=16051500, pageToken=NULL)
  reads <- callGRPCMethod("SearchReads", request)
  summary(reads)
} else {
  message("gRPC support is disabled; package was not compiled with GRPC")
}

Bioconductor/GoogleGenomics documentation built on May 6, 2019, 7:51 a.m.