ontotext |
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 term(s) original full textDescription
ontotext reads one or more complete ontology term entries from a database or a file and writes them to a text file. Optionally, the first ontology term from the input stream only can be retrieved. The complete entry, including heading annotation, is retrieved and written and the data is not altered or reformatted in any way.
Usage
Here is a sample session with ontotext
% ontotext edam:0001234 Get ontology term(s) original full text Output file [0001234.ontotext]: |
Go to the input files for this example
Go to the output files for this example
Example 2
% ontotext edam:0000850 -subclasses Get ontology term(s) original full text Output file [0000850.ontotext]: |
Go to the input files for this example
Go to the output files for this example
Command line arguments
Get ontology term(s) original full text Version: EMBOSS:6.4.0.0 Standard (Mandatory) qualifiers: [-oboterms] obo Obo term filename and optional format, or reference (input query) [-outfile] outfile [*.ontotext] Output file name Additional (Optional) qualifiers: -subclasses boolean [N] Extend the query matches to include all terms which are specialisations (sub-classes) of the matched terms. -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 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) |
outfile | Output file name | Output file | <*>.ontotext |
Additional (Optional) qualifiers | ||||
-subclasses | boolean | Extend the query matches to include all terms which are specialisations (sub-classes) of the matched terms. | Boolean value Yes/No | No |
-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 outfile qualifiers | ||||
-odirectory2 -odirectory_outfile |
string | Output directory | 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
The input is a standard EMBOSS ontology query.
The major ontology sources defined as standard in EMBOSS installations are EDAM, GO (gene Ontology) and SO (Sequence Ontology).
Data can also be read from ontology output in "obo" format written by an EMBOSS application.
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 |
Input files for usage example 2
Database entry: edam:0000850
[Term] id: EDAM:0000850 name: Sequence set namespace: data def: A collection of multiple molecular sequences and associated metadata that do not (typically) correspond to molecular sequence database records or entries and which (typically) are derived from some analytical method. comment: This term may be used for arbitrary sequence sets and associated data arising from processing. subset: data is_a: EDAM:0002955 ! Sequence report |
Output file format
ontotext reports the full text of the input ontology terms.Output files for usage example
File: 0001234.ontotext
[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." [EDAM:EBI "EMBRACE definition"] subset: data is_a: EDAM:0000850 ! Sequence set is_a: EDAM:0002977 ! Nucleic acid sequence |
Output files for usage example 2
File: 0000850.ontotext
[Term] id: EDAM:0000850 name: Sequence set namespace: data def: "A collection of multiple molecular sequences and associated metadata that do not (typically) correspond to molecular sequence database records or entries and which (typically) are derived from some analytical method." [EDAM:EBI "EMBRACE definition"] comment: This term may be used for arbitrary sequence sets and associated data arising from processing. subset: data is_a: EDAM:0002955 ! Sequence report [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." [EDAM:EBI "EMBRACE definition"] subset: data is_a: EDAM:0000850 ! Sequence set is_a: EDAM:0002977 ! Nucleic acid sequence [Term] id: EDAM:0001240 name: PCR primers namespace: data def: "Oligonucleotide primer(s) for PCR and DNA amplification, for example a minimal primer set." [EDAM:EBI "EMBRACE definition"] subset: data is_a: EDAM:0001234 ! Sequence set (nucleic acid) [Term] id: EDAM:0001246 name: Sequence cluster (nucleic acid) namespace: data def: "A cluster of nucleotide sequences." [EDAM:EBI "EMBRACE definition"] comment: The sequences are typically related, for example a family of sequences. subset: data synonym: "Nucleotide sequence cluster" EXACT [] is_a: EDAM:0001234 ! Sequence set (nucleic acid) is_a: EDAM:0001235 ! Sequence cluster [Term] id: EDAM:0002198 name: Gene cluster namespace: data def: "A cluster of similar genes." [EDAM:EBI "EMBRACE definition"] subset: data is_a: EDAM:0001246 ! Sequence cluster (nucleic acid) [Term] id: EDAM:0002874 name: Sequence set (polymorphic) namespace: data def: "A set of sub-sequences displaying some type of polymorphism, typically indicating the sequence in which they occur, their position and other metadata." [EDAM:EBI "EMBRACE definition"] [Part of this file has been deleted for brevity] subset: data is_a: EDAM:0000850 ! Sequence set ! is_a: EDAM:0002976 ! Protein sequence [Term] id: EDAM:0001245 name: Sequence cluster (protein) namespace: data def: "A cluster of protein sequences." [EDAM:EBI "EMBRACE definition"] comment: The sequences are typically related, for example a family of sequences. subset: data synonym: "Protein sequence cluster" EXACT [] is_a: EDAM:0001233 ! Sequence set (protein) is_a: EDAM:0001235 ! Sequence cluster [Term] id: EDAM:0001238 name: Proteolytic digest namespace: data def: "A protein sequence cleaved into peptide fragments (by enzymatic or chemical cleavage) with fragment masses." [EDAM:EBI "EMBRACE definition"] subset: data is_a: EDAM:0001233 ! Sequence set (protein) [Term] id: EDAM:0001262 name: Peptide molecular weight hits namespace: data def: "A report on peptide fragments of certain molecular weight(s) in one or more protein sequences." [EDAM:EBI "EMBRACE definition"] subset: data is_a: EDAM:0001233 ! Sequence set (protein) [Term] id: EDAM:0001235 name: Sequence cluster namespace: data def: "A set of sequences that have been clustered or otherwise classified as belonging to a group including (typically) sequence cluster information." [EDAM:EBI "EMBRACE definition"] comment: The cluster might include sequences identifiers, short descriptions, alignment and summary information. subset: data is_a: EDAM:0000850 ! Sequence set relationship: in_topic EDAM:0000164 ! Sequence clustering relationship: in_topic EDAM:0000724 ! Protein families [Term] id: EDAM:0002245 name: Sequence set (bootstrapped) namespace: data def: "A collection of sequences output from a bootstrapping (resampling) procedure." [EDAM:EBI "EMBRACE definition"] comment: Bootstrapping is often performed in phylogenetic analysis. subset: data is_a: EDAM:0000850 ! Sequence set |
Data files
The EDAM Ontology is included in EMBOSS as local database edam.Notes
None.References
None.Warnings
None.Diagnostic Error Messages
None.Exit status
It always exits with status 0.Known bugs
None.See also
Program name | Description |
---|---|
drtext | Get data resource entries complete text |
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 |
entret | Retrieves sequence entries from flatfile databases and files |
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 |
ontogetroot | Get ontology root terms by child identifier |
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 |
textget | Get text data entries |
textsearch | Search the textual description of sequence(s) |
Author(s)
Peter RiceEuropean 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.