entity_name: Get the entity name from a GDCQuery object

View source: R/entity_name.R

entity_nameR Documentation

Get the entity name from a GDCQuery object

Description

An "entity" is simply one of the four medata endpoints.

  • cases

  • projects

  • files

  • annotations

All GDCQuery objects will have an entity name. This S3 method is simply a utility accessor for those names.

Usage

entity_name(x)

## S3 method for class 'GDCQuery'
entity_name(x)

## S3 method for class 'GDCResults'
entity_name(x)

Arguments

x

a GDCQuery object

Value

character(1) name of an associated entity; one of "cases", "files", "projects", "annotations".

Examples

qcases = cases()
qprojects = projects()

entity_name(qcases)
entity_name(qprojects)


Bioconductor/GenomicDataCommons documentation built on Oct. 15, 2024, 8:35 p.m.