field_description {GenomicDataCommons} | R Documentation |
S3 Generic that returns the field description text, if available
field_description(entity, field) ## S3 method for class 'GDCQuery' field_description(entity, field) ## S3 method for class 'character' field_description(entity, field)
entity |
character(1) string ('cases','files','projects',
'annotations', etc.) or an subclass of |
field |
character(1), the name of the field that will be used to look up the description. |
character(1) descriptive text or character(0) if no description is available.
GDCQuery
: GDCQuery method
character
: character method
field_description('cases', 'annotations.category') casesQuery = query('cases') field_description(casesQuery, 'annotations.category') field_description(cases(), 'annotations.category')