Skip to contents

Return valid values for "expand"

Source: R/expand.R
available_expand.Rd

The GDC allows a shorthand for specifying groups of fields to be returned by the metadata queries. These can be specified in a select method call to easily supply groups of fields.

Usage

available_expand(entity)

# S3 method for character
available_expand(entity)

# S3 method for GDCQuery
available_expand(entity)

Arguments

entity

Either a GDCQuery object or a character(1) specifying a GDC entity ('cases', 'files', 'annotations', 'projects')

Value

A character vector

See also

See https://docs.gdc.cancer.gov/API/Users_Guide/Search_and_Retrieval/#expand for details

Examples

head(available_expand('files'))
#> [1] "analysis"                                    
#> [2] "analysis.input_files"                        
#> [3] "analysis.metadata"                           
#> [4] "analysis.metadata.read_groups"               
#> [5] "analysis.metadata.read_groups.read_group_qcs"
#> [6] "annotations"