field_description {GenomicDataCommons}R Documentation

S3 Generic that returns the field description text, if available

Description

S3 Generic that returns the field description text, if available

Usage

field_description(entity, field)

Arguments

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.

Value

character(1) descriptive text or character(0) if no description is available.

Examples

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


[Package GenomicDataCommons version 1.14.0 Index]