getSchemaClass: Schema class queries

View source: R/getContent.R

getSchemaClassR Documentation

Schema class queries

Description

Fetch instances by Class. All Classes see Reactome data schema.

Usage

getSchemaClass(
  class,
  species = NULL,
  all = FALSE,
  rows = 1000,
  minimised = FALSE,
  reference = FALSE
)

Arguments

class

schema class name

species

name or taxon id or dbId or abbreviation of species. Only Event and PhysicalEntity classes can specify species

all

to return ALL entries or not, default is FALSE

rows

the number of entries retrieved, default is 1000

minimised

to retrieve simplified entries (db id, stable id, displayName, type) or not, default is FALSE

reference

to retrieve simplified reference objects (db id, external identifier, external database name) or not, default is FALSE. Only for ReferenceEntity or ExternalOntology class

Value

a sorted dataframe containing entries that belong to the specified schema class

See Also

Other getContent: getEntities(), getEventsHierarchy(), getOrthology(), getParticipants(), getPathways(), getPerson(), getSpecies(), query()

Examples

## Not run: 
getSchemaClass(class="Drug", all=TRUE)

## End(Not run)
getSchemaClass(class="Regulation", rows=20, minimised=TRUE)
getSchemaClass(class="Complex", species="pig", rows=10)

reactome/ReactomeContentService4R documentation built on May 1, 2023, 5:33 a.m.