id_field {GenomicDataCommons} | R Documentation |
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.
id_field(x) ## S3 method for class 'GDCQuery' id_field(x) ## S3 method for class 'GDCResults' id_field(x)
x |
An object representing the query or results of an entity from the GDC ("cases", "files", "annotations", "projects") |
character(1) such as "case_id", "file_id", etc.
GDCQuery
: GDCQuery method
GDCResults
: GDCResults method
id_field(cases())