An R package for Google Genomics API queries.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
man
shiny
src
tests
vignettes
.Rbuildignore
.gitignore
.travis.yml
CONTRIBUTING.rst
DESCRIPTION
GRPC.rst
GoogleGenomics.Rproj
LICENSE
NAMESPACE
NEWS
README.rst
cleanup
configure
configure.ac
configure.win

README.rst

GoogleGenomics Build Status

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.

Installing

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)

Authentication

Call authenticate to set up credentials. Check the function documentation for details on various available options. The function will return TRUE on successful authentication.

Examples

See the following examples for more detail:

Project status

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.