field_description: S3 Generic that returns the field description text, if...
In GenomicDataCommons: NIH / NCI Genomic Data Commons Access

Description Usage Arguments Value Examples

S3 Generic that returns the field description text, if available

1	field_description(entity, field)

`entity`	character(1) string ('cases','files','projects', 'annotations', etc.) or an subclass of `GDCQuery`.
`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.

field_description('cases', 'annotations.category')
casesQuery = query('cases')
field_description(casesQuery, 'annotations.category')
field_description(cases(), 'annotations.category')