ontogetroot |
Wiki
The master copies of EMBOSS documentation are available at http://emboss.open-bio.org/wiki/Appdocs on the EMBOSS Wiki.Please help by correcting and extending the Wiki pages.
Function
Get ontology root terms by child identifierDescription
ontogetroot displays on-screen for a named ontology the root term statement(s). The information may be written to an output file in various formats.
Ontologies from the EMBOSS data directory are used.
Usage
Here is a sample session with ontogetroot
% ontogetroot edam:0001234 Get ontology root terms by child identifier Obo output file [0001234.obo]: |
Go to the input files for this example
Go to the output files for this example
Command line arguments
Get ontology root terms by child identifier Version: EMBOSS:6.4.0.0 Standard (Mandatory) qualifiers: [-oboterms] obo Obo term filename and optional format, or reference (input query) [-outfile] outobo [*.ontogetroot] Output ontology term file name Additional (Optional) qualifiers: -obsolete boolean [N] The default behaviour is to not use or return obsolete terms. This option if set will include all terms. Advanced (Unprompted) qualifiers: (none) Associated qualifiers: "-oboterms" associated qualifiers -iformat1 string Input obo format -idbname1 string User-provided database name "-outfile" associated qualifiers -odirectory2 string Output directory -oformat2 string Ontology term output format General qualifiers: -auto boolean Turn off prompts -stdout boolean Write first file to standard output -filter boolean Read first file from standard input, write first file to standard output -options boolean Prompt for standard and additional values -debug boolean Write debug output to program.dbg -verbose boolean Report some/full command line options -help boolean Report command line options and exit. More information on associated and general qualifiers can be found with -help -verbose -warning boolean Report warnings -error boolean Report errors -fatal boolean Report fatal errors -die boolean Report dying program messages -version boolean Report version number and exit |
Qualifier | Type | Description | Allowed values | Default |
---|---|---|---|---|
Standard (Mandatory) qualifiers | ||||
[-oboterms] (Parameter 1) |
obo | Obo term filename and optional format, or reference (input query) | OBO bio-ontology term(s) | |
[-outfile] (Parameter 2) |
outobo | Output ontology term file name | OBO ontology term(s) | <*>.ontogetroot |
Additional (Optional) qualifiers | ||||
-obsolete | boolean | The default behaviour is to not use or return obsolete terms. This option if set will include all terms. | Boolean value Yes/No | No |
Advanced (Unprompted) qualifiers | ||||
(none) | ||||
Associated qualifiers | ||||
"-oboterms" associated obo qualifiers | ||||
-iformat1 -iformat_oboterms |
string | Input obo format | Any string | |
-idbname1 -idbname_oboterms |
string | User-provided database name | Any string | |
"-outfile" associated outobo qualifiers | ||||
-odirectory2 -odirectory_outfile |
string | Output directory | Any string | |
-oformat2 -oformat_outfile |
string | Ontology term output format | Any string | |
General qualifiers | ||||
-auto | boolean | Turn off prompts | Boolean value Yes/No | N |
-stdout | boolean | Write first file to standard output | Boolean value Yes/No | N |
-filter | boolean | Read first file from standard input, write first file to standard output | Boolean value Yes/No | N |
-options | boolean | Prompt for standard and additional values | Boolean value Yes/No | N |
-debug | boolean | Write debug output to program.dbg | Boolean value Yes/No | N |
-verbose | boolean | Report some/full command line options | Boolean value Yes/No | Y |
-help | boolean | Report command line options and exit. More information on associated and general qualifiers can be found with -help -verbose | Boolean value Yes/No | N |
-warning | boolean | Report warnings | Boolean value Yes/No | Y |
-error | boolean | Report errors | Boolean value Yes/No | Y |
-fatal | boolean | Report fatal errors | Boolean value Yes/No | Y |
-die | boolean | Report dying program messages | Boolean value Yes/No | Y |
-version | boolean | Report version number and exit | Boolean value Yes/No | N |
Input file format
Input files for usage example
Database entry: edam:0001234
[Term] id: EDAM:0001234 name: Sequence set (nucleic acid) namespace: data def: Any collection of multiple nucleotide sequences and associated metadata that do not (typically) correspond to common sequence database records or database entries. subset: data is_a: EDAM:0000850 ! Sequence set is_a: EDAM:0002977 ! Nucleic acid sequence |
Output file format
The default behaviour is to report the entire OBO term statement from the ontology. Optionally, then only the the term id, name and namespace, or just the term id will be reported.
The output file by default is in OBO plain text format as used by the ontologies in the EMBOSS data directory and explained at http://www.geneontology.org/GO.format.obo-1_2.shtml.
Optionally, the output can be in HTML, OBO-XML or JSON format.
Output files for usage example
File: 0001234.obo
[Term] id: EDAM:0000006 name: Data namespace: data def: A type of data in common use in bioinformatics. subset: data |
Data files
OBO-format ontologies must be installed in the EMBOSS data directory and indexed. This is done automatically for typical installations.
Notes
References
Warnings
None.Diagnostic Error Messages
None.Exit status
It exits with a status of 0.Known bugs
None.See also
Program name | Description |
---|---|
edamdef | Find EDAM ontology terms by definition |
edamhasinput | Find EDAM ontology terms by has_input relation |
edamhasoutput | Find EDAM ontology terms by has_output relation |
edamisformat | Find EDAM ontology terms by is_format_of relation |
edamisid | Find EDAM ontology terms by is_identifier_of relation |
edamname | Find EDAM ontology terms by name |
godef | Find GO ontology terms by definition |
goname | Find GO ontology terms by name |
ontocount | Count ontology term(s) |
ontoget | Get ontology term(s) |
ontogetcommon | Get common ancestor for terms |
ontogetdown | Get ontology term(s) by parent id |
ontogetobsolete | Get ontology ontology terms |
ontogetsibs | Get ontology term(s) by id with common parent |
ontogetup | Get ontology term(s) by id of child |
ontoisobsolete | Report whether an ontology term id is obsolete |
ontotext | Get ontology term(s) original full text |
Author(s)
Jon IsonEuropean Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK
Please report all bugs to the EMBOSS bug team (emboss-bug © emboss.open-bio.org) not to the original author.
This application was modified by
Jon Ison
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK
Please report all bugs to the EMBOSS bug team (emboss-bug © emboss.open-bio.org) not to the original author.