getrelatives

Class: geneont

Find terms that are relatives of specified Gene Ontology (GO) term

Syntax

RelativeIDs = getrelatives(GeneontObj, ID)
[RelativeIDs, Counts] = getrelatives(GeneontObj, ID)
... = getrelatives(..., 'Height', HeightValue, ...)
... = getrelatives(..., 'Depth', DepthValue, ...)
... = getrelatives(..., 'Levels', LevelsValue, ...)
... = getrelatives(..., 'Relationtype', RelationtypeValue, ...)
... = getrelatives(..., 'Exclude', ExcludeValue, ...)


Description

RelativeIDs = getrelatives(GeneontObj, ID) searches GeneontObj, a geneont object, for GO terms that are relatives of the GO term(s) specified by ID, which is a GO term identifier or vector of identifiers. It returns RelativeIDs, a vector of GO term identifiers including ID. ID is a nonnegative integer or a vector containing nonnegative integers.

[RelativeIDs, Counts] = getrelatives(GeneontObj, ID) also returns the number of times each relative is found. Counts is a column vector with the same number of elements as terms in GeneontObj.

Tip

The Counts return value is useful when you tally counts in gene enrichment studies.

... = getrelatives(..., 'PropertyName', PropertyValue, ...) calls getrelatives with optional properties that use property name/property value pairs. You can specify one or more properties in any order. Each PropertyName must be enclosed in single quotation marks and is case insensitive. These property name/property value pairs are as follows:

... = getrelatives(..., 'Height', HeightValue, ...) searches up through a specified number of levels, HeightValue, in the gene ontology. HeightValue is a positive integer. Default is 1.

... = getrelatives(..., 'Depth', DepthValue, ...) searches down through a specified number of levels, DepthValue, in the gene ontology. DepthValue is a positive integer. Default is 1.

... = getrelatives(..., 'Levels', LevelsValue, ...) searches up and down through a specified number of levels, LevelsValue, in the gene ontology. LevelsValue is a positive integer. When specified, it overrides HeightValue and DepthValue.

... = getrelatives(..., 'Relationtype', RelationtypeValue, ...) searches for specified relationship types, RelationtypeValue, in the gene ontology. RelationtypeValue is a character vector. Choices are 'is_a', 'part_of', or 'both' (default).

... = getrelatives(..., 'Exclude', ExcludeValue, ...) controls excluding ID, the original queried term(s), from the output RelativeIDs, unless a term was found while searching the gene ontology. Choices are true or false (default).

Input Arguments

GeneontObj	A geneont object, such as created by the geneont constructor function.
ID	GO term identifier or vector of identifiers.
HeightValue	Positive integer specifying the number of levels to search upward in the gene ontology.
DepthValue	Positive integer specifying the number of levels to search downward in the gene ontology.
LevelsValue	Positive integer specifying the number of levels up and down to search in the gene ontology. When specified, it overrides HeightValue and DepthValue.
RelationtypeValue	Character vector specifying the relationship types to search for in the gene ontology. Choices are: 'is_a' 'part_of' 'both' (default)
ExcludeValue	Controls excluding ID, the original queried term(s), from the output RelativeIDs, unless the term was reached while searching the gene ontology. Choices are true or false (default).

Output Arguments

RelativeIDs	Vector of GO term identifiers including ID.
Counts	Column vector with the same number of elements as terms in GeneontObj, indicating the number of times each relative is found.

Examples

1. Download the current version of the Gene Ontology database from the Web into a geneont object in the MATLAB^® software.

   GO = geneont('LIVE', true)

   The MATLAB software creates a geneont object and displays the number of terms in the database.

   Gene Ontology object with 27769 Terms.

2. Retrieve the immediate relatives for the mitochondrial membrane GO term with a GO identifier of 31966.

   relatives = getrelatives(GO,31966,'levels',1)
   
   relatives =
   
           5741
           5743
          31090
          31966
          44429

3. Create a subordinate Gene Ontology.

   subontology = GO(relatives)
   
   Gene Ontology object with 5 Terms.

4. Create a report of the subordinate Gene Ontology terms, that includes the GO identifier and name.

   rpt = get(subontology.terms,{'id','name'})
   
   rpt = 
   
       [ 5741]             [1x28 char]
       [ 5743]             [1x28 char]
       [31090]    'organelle membrane'
       [31966]             [1x22 char]
       [44429]    'mitochondrial part'

5. Retrieve all relatives for the mitochondrial outer membrane GO term with an identifier of 5741.

   relatives = getrelatives(GO,5741,'levels',inf);
   

6. Create a subordinate Gene Ontology.

   subontology = GO(relatives)
   
   Gene Ontology object with 13 Terms.