Child pages
  • CPTAC Clinical Data API

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Clinical data from CPTAC-3 are now being made available through an API hosted by ESAC.  This is documented in detail at https://clinicalapi-cptac.esacinc.com/api/tcia/. Data are provided in JSON, which is a file format commonly used by software developers for data interchange.  Most data scientists and statisticians should already be familiar with this type of file, but for users who are not familiar working with JSON, we are providing a few examples of ways to access this data.  


  1. Your Browser will display the interface differently:
    1. Firefox (recommended)
    2. Chrome
    3. Edge (and notepad++)
    4. Safari (and sublime text or oxygenxml)
  2. You may
    1. view the data online (Firefox) in human-readable format
    2. download to your local machine for viewing and analysis

Anchor
ViewFirefox
ViewFirefox
View JSON files in Firefox

Open Firefox and navigate to one of our CPTAC collection pages (e.g. CPTAC-CCRCC) and click the blue download button for the Clinical Data API:

Click the Raw data Data button at the top of the page, and then click Pretty Print.  This will arrange the data in a way that is more human-readable.

...

There are a number of free online tools such as https://json-csv.com/ which will convert between JSON and CSV, which can be viewed in most spreadsheet applications like Excel.  After the page loads simply paste in the URL for the cancer type you were trying to access, e.g. https://clinicalapi-cptac.esacinc.com/api/tcia/clinical_data/tumor_code/UCEC.

...

For Edge browser, and Notepad++ editor: 

enter image description hereImage Modified

Open Notepad++. From the Plugins menu click "Plugins Admin" then type JSON into the search bar, you should see "JSON viewer" as an option. Click install.

...

The following guide has been prepared for researchers who are not used to working with JSON data or APIs.  By following these steps you will be able to view the data in newer versions of Excel via the "Power Query" or "Get and Transform" feature.  

Excel 2010 and Excel 2013 for Windows

Power Query is a free add-in that can be downloaded here: Download the Power Query add-in. Once enabled, Power Query functionality is available from the Power Query tab on the ribbon. 

To generate the JSON file:

...

                                                     

  • Anchor
    ChromeView
    ChromeView
    For Chrome Browser:
    • Right-click anywhere in the in the middle of the page and select “Save as…” and save the file in your desired location

                                                                                                  

  • Anchor
    EdgeView
    EdgeView
    For Edge Browser you cannot save directly,  there are more steps:
    • Right-click anywhere in the in the middle of the page and select "Select all"Image Added
    • then right-click again, click “Copy” 
    • Image Added
    • "Paste" the contents of the file into an editor, for example "Notepad++",
      • Give your new file a new name
      • as file type JSON
      • Click Save.
    •    Image Added




  • For Firefox browser:
    • Click on “Save” near the top left corner of the page and save the file in your desired location

...

                                             

Load and Convert the JSON Clinical Data file into an Excel Sheet (Office 365)

  • Open a blank Excel sheet in Office 365
  • From the main menu, select “Data
  • From the “Get Data” drop down menu, select “From File”, then “From JSON”  **if you can't, see below for custom query
  • Select your CPTAC JSON file from the directory where you saved it previously.

...

  • Note: The “specimens” column has a sub-level with specimen-related column headings (specimen id, slide id, etc) which prevent it from showing up without additional processing.  We recommend simply deleting this column.



  • Note:  You can also use the Microsoft Excel Query Editor to create formulas to connect to JSON files. If you don't see the Get Data → From JSON button, you can go to New Query > From Other Sources > Blank Query, then go to Advanced Editor and input your custom query string, then follow the other instructions above to convert from the json file to the tabular format.


    Code Block
    titleBlank Query to import JSON
    let
    
    Source = Json.Document(File.Contents("C:\Users\Name\Desktop\CPTAC-AML-download.json")), #"Converted to Table" = Record.ToTable(Source)
    
    in
    
    #"Converted to Table"


  • Image Added

Save As Excel Worksheet

  • After you have customized the table, select “Close and Load
  • Then click on "File", and "Save" to save as an Excel document

Image Added