Skip to contents

S3 Generic that returns the field description text, if available

Source: R/fields.R
field_description.Rd

S3 Generic that returns the field description text, if available

Usage

field_description(entity, field)

# S3 method for GDCQuery
field_description(entity, field)

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

Methods (by class)

  • field_description(GDCQuery): GDCQuery method

  • field_description(character): character method

Examples

field_description('cases', 'annotations.category')
#> [1] "Top level characterization of the annotation."
casesQuery = query('cases')
field_description(casesQuery, 'annotations.category')
#> [1] "Top level characterization of the annotation."
field_description(cases(), 'annotations.category')
#> [1] "Top level characterization of the annotation."