OpenCGA
OverviewInstallationUsing OpenCGA
v2.2
v2.2
  • Home
  • Overview
    • Features
    • Architecture Diagram
    • Security
    • Metadata and Clinical Data
    • Data Models
      • Sample
      • Individual
    • Alignment and Coverage
    • Variant Query and Analysis
    • Clinical Data Analysis
    • Running Analysis
    • Scalability and Performance
    • Sizing OpenCGA
  • OpenCGA Architecture
    • Catalog
    • Alignment and Coverage
    • Variant Storage Engine
      • Variant Data Model
    • Clinical Analysis
    • Analysis Framework
  • Data Models
    • User
    • Project
    • Study
    • File
    • Sample
    • Individual
    • Family
    • Cohort
    • Job
    • Clinical Analysis
  • Case Studies
    • Genomics England Research
    • Microsoft Azure
  • User Manual
    • Installation
      • Kubernetes Cluster
        • Azure
        • Configuration
      • On-Premise HPC Cluster
        • Server Configuration
        • Getting OpenCGA
        • Choosing Variant Storage Engine
        • Configuration
      • Running Docker
    • Login
    • Using OpenCGA
      • REST Web Service API
      • IVA Web App
      • Client Libraries
        • pyopencga - Python Library
        • opencgaR - R library
        • Java
        • JavaScript
      • Command Line
        • Configuration
        • Files
      • Public Demo
    • Managing Data
      • Working with Projects and Studies
      • Loading of VCF files
      • Create Projects and Studies
      • Load VCF Files to a Study
      • Working with Files
      • Sharing and Permissions
        • Users and Groups
        • Study ACLs
      • Population of metadata
        • Data Versioning
        • Adding Custom Metadata
    • Alignment Engine
      • BAM Index
      • Alignment Read Query
      • Working with Coverage
      • Alignment Analysis
    • Variant Storage Engine
      • Variant Query
      • Variant Aggregation Stats
      • Variant Analysis
    • Clinical Genomics
      • Clinical Interpretation
      • Clinical Analysis
    • Using JupyterLab
    • Administrator
      • User Management
      • Templates / Manifest
  • About
    • Roadmap
    • Release Notes
    • Community
Powered by GitBook
On this page
  • Overview
  • Installation
  • Requisites
  • Installation from the R terminal

Was this helpful?

  1. User Manual
  2. Using OpenCGA
  3. Client Libraries

opencgaR - R library

If you're a R user and you're keen of running OpenCGA through R, you're in the right place!

Previouspyopencga - Python LibraryNextJava

Last updated 3 years ago

Was this helpful?

Overview

opencgaR is an R library that interacts with OpenCGA REST API to execute any operation supported by the web services through R code.

The client offers programmatic access to the implemented REST web services, facilitating the access and analysis of data stored in OpenCGA. From version 2.0.0 data is returned in a new RestResponse object which contains metadata and the results. The client also implements some handy methods to return information from this object.

opencgaR code has been implemented by Marta Bleda. It's open-source and can be found at . It can be installed easily by downloading the pre-build package. Please, find more details on how to use the R library at .

Installation

Requisites

  • An operating machine with R installed and functional. opencgaR requires at least R version 3.4 (although most of the code is fully compatible with earlier versions).

  • Have the pre-build R package stored in your local machine. Alternatively you can also provide the URL to the pre-build R package file.

    The pre-build R package of opencgaR can be downloaded from the OpenCGA v2.0.0 GitHub Release at .

Once requirements have been fulfilled, installing opencgaR becomes as easy as use the install.packages function in R. install.packages can also install a source package from a remote .tar.gz file by providing the URL to such file.

Installation from the R terminal

## Install opencgaR by providing the URL to the package
> install.packages("opencgaR_2.0.0.tar.gz", repos=NULL, type="source")
https://github.com/opencb/opencga/tree/develop/opencga-client/src/main/R
Using the R client
https://github.com/opencb/opencga/releases