Metadata.Patients: Retrieve list of all TCGA patients.

Description Usage Arguments

View source: R/Metadata.Patients.R

Description

This service returns a list of all TCGA patient barcodes in FireBrowse, optionally filtered by disease cohort. The barcodes are obtained directy from the clinical data.

Usage

1
2
Metadata.Patients(format = "json", cohort = "", page = "1",
  page_size = "250", sort_by = "cohort")

Arguments

format

Format of result. Default value is json. While json,tsv,csv are available.

cohort

Narrow search to one or more TCGA disease cohorts from the scrollable list. Multiple values are allowed ACC,BLCA,BRCA,CESC,CHOL,COAD,COADREAD,DLBC,ESCA,FPPP,GBM,GBMLGG,HNSC,KICH,KIPAN,KIRC,KIRP,LAML,LGG,LIHC,LUAD,LUSC,MESO,OV,PAAD,PCPG,PRAD,READ,SARC,SKCM,STAD,STES,TGCT,THCA,THYM,UCEC,UCS,UVM.

page

Which page (slice) of entire results set should be returned. Multiple values are allowed . Default value is 1.

page_size

Number of records per page of results. Max is 2000. Multiple values are allowed . Default value is 250.

sort_by

Which column in the results should be used for sorting paginated results? Default value is cohort. While cohort are available.


mariodeng/FirebrowseR documentation built on May 21, 2017, 6:48 p.m.