Skip to contents

get the name of the id field

Source: R/ids.R
id_field.Rd

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 GDCQuery
id_field(x)

# S3 method for 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)

  • id_field(GDCQuery): GDCQuery method

  • id_field(GDCResults): GDCResults method

Examples

id_field(cases())
#> [1] "case_id"