Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.71 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.71 KB

Travis build status AppVeyor build status Codecov test coverage

biogridapi

An R client for BIOGRID API

Overview

Provide a set of functions to interact with the BIOGRID API in R.

Installing biogridapi

The package can be installed using devtools

devtools::install_github('abifromr/biogridapi')

Getting started

A simple example to show how the package works is to contrast with an example query using curl.

curl https://webservice.thebiogrid.org/interactions?searchNames=true&geneList=MDM2&includeInteractors=true&includeInteractorInteractions=false&taxId=9606&accesskey=[ACCESSKEY]

This would look like the following using biogridapi

accessKey=<'32 alphanumeric string'>
interactions(accessKey=accessKey,
             geneList = 'DM2',
             searchNames = TRUE,
             includeInteractors = TRUE,
             taxId = 9606)

For this example to work using either curl or biogridapi an accessKey is needed from here.

Acknowledgement

  • This implementation is based on the BIOGRID API documentation, here.
  • Best practices for API packages guide was a very useful resource,here