Overview

To do very simple queries on the clinical/phenotype data you can use the LabKey application on the Research Environment desktop. However, in order to do more complex analyses across multiple tables, or query very large tables, it is recommended that you use the provided LabKey APIs.

The LabKey client libraries (APIs) provide secure, auditable, programmatic access to LabKey data and services and allow you to:

Currently, LabKey supports working with the following programming languages/environments.

We highly recommend using either the Python LabKey API or the R LabKey API to query the Genomics England clinical/phenotype data.

Configuring access

(warning) You firstly need to provide your credentials to the API so that you can access the data you are allowed.(warning)

This only needs to be one once in order to use the API.

These credentials are stored in a file called .netrc (dot net rc), located in your home directory. This file does not exist initially, so you will have to create it. To do this:

Once in your home directory, we will create the .netrc file. You can use any text editor to do this, but this guide we will use nano.

This file needs the following three lines in it, where you change the username and password fields to your Research Environment credentials:

machine labkey-embassy.gel.zone
login username
password password

Because the file contains your password, it should be set to read-write only for yourself.

Further configuration

For R and Python you will need to make specific changes to your scripts. Please have a look at the following pages for example scripts and how to set up your own script:

R LabKey API 

Python LabKey API

Note: For the R LabKey API you will also need, as of April 2020, to create or reconfigure the .Renviron file. See R, RStudio, and R libraries#Creatingan.Renvironfile(alsorequiredfortheRLabKeyAPI).

Troubleshooting: Potential errors upon incorrect setup (i.e. DOCTYPE, user permission denied, curl_fetch_memory)

In case the RLabKey API is incorrectly setup, please have a look here:
LabKey DOCTYPE error

LabKey curl_fetch_memory error
If this does not resolve the issue, and you still have problems using the R LabKey API, please contact the Service Desk.