This R client fetches reads and variants data from the Google Genomics API and provides converters to obtain Bioconductor S4 classes like GAlignments, and GRanges and VRanges.
Use the Bioconductor repositories to install this package.
If you have gRPC installed, you will be able to access the entire v1
Google Genomics API through the callGRPCMethod
function provided in
the package and use more performant reads and variant search methods.
Without gRPC support, you will still be able to query reads and variants;
see the vignettes for sample usage.
[Optional] Installing gRPC
See our guide on gRPC.
Installing R package
source("http://bioconductor.org/biocLite.R") useDevel(TRUE) # Skip this step if you do not want the devel version. biocLite("GoogleGenomics") # If gRPC is not installed. biocLite("GoogleGenomics", type="source") # If gRPC is installed. library(GoogleGenomics)
Call authenticate
to set up credentials. Check the function
documentation for details on various available options. The function will
return TRUE
on successful authentication.
See the following examples for more detail:
- Working with Reads
- Working with Variants
- Variant Annotation Comparison Test
- and also the integration tests
The package is integrated with gRPC when available on the system where the package was built. With gRPC support, the entire v1 API is accessible. Without gRPC support, this package can be used to search for reads and variants, and convert them to various Bioconductor formats.