get_ga4gh: GET an Object

Description Usage Arguments Examples

View source: R/get_ga4gh.R

Description

GET an object from the GA4GH API

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
get_ga4gh(object, ...)

## S3 method for class 'ga4ghClient'
get_ga4gh(object, operation, id, ...)

## Default S3 method:
get_ga4gh(object, operation, id, port = NULL, ...)

## S3 method for class 'list'
get_ga4gh(object, operation, id, ...)

Arguments

object

An object to GET from. I.e. A ga4ghClient object, a url for the server or a list of either.

...

Arguments to pass to other methods

operation

The name of the operation. Eg "datasets"

id

The ID of the Object

port

The port number

Examples

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

## Not run: 

## Use the client and get an object from the api
ref_client %>% get_ga4gh("datasets", "id")

## Or provide the API location as a string
get_ga4gh("http://1kgenomes.ga4gh.org", "datasets", "id")

## End(Not run)

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