id_field: get the name of the id field

In GenomicDataCommons: NIH / NCI Genomic Data Commons Access

Description

In many places in the GenomicDataCommons package, the entity ids are stored in a column or a vector with a specific name that corresponds to the field name at the GDC. The format is the entity name (singular) "_id". This generic simply returns that name from a given object.

Usage

id_field(x)

## S3 method for class 'GDCQuery'
id_field(x)

## S3 method for class 'GDCResults'
id_field(x)

Arguments

x	An object representing the query or results of an entity from the GDC ("cases", "files", "annotations", "projects")

Value

character(1) such as "case_id", "file_id", etc.

Methods (by class)

• GDCQuery: GDCQuery method

• GDCResults: GDCResults method

Examples

id_field(cases())

GenomicDataCommons documentation built on Nov. 8, 2020, 11:08 p.m.