ajobowrite.c
Datatypes: AjPFile none
Obo Term output
Sections: obo term outputs
These functions write the obo term provided by the first argument
Functions: ajObooutWrite
Write an OBO term in a named format
Synopsis
Prototype
AjBool ajObooutWrite (
AjPOutfile outf,
const AjPObo obo
);
| Type | Name | Read/Write | Description |
|---|
| AjPOutfile | outf | Modify | Output file |
| const AjPObo | obo | Input | Obo term object |
| AjBool | | RETURN | True on success |
Input
| obo: | (Input) | Obo term object |
Input & Output
Returns
Description
Write an OBO term in a named format
See Also
See other functions in this section
Availability
In release 6.4.0
Miscellaneous functions
Sections: Print
Printing to a file
Functions: ajObooutprintBook ajObooutprintHtml ajObooutprintText ajObooutprintWiki
Reports the obo term format internals as Docbook text
Synopsis
Prototype
void ajObooutprintBook (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the obo term format internals as Docbook text
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the internal data structures
Synopsis
Prototype
void ajObooutprintHtml (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the internal data structures
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the internal data structures
Synopsis
Prototype
void ajObooutprintText (
AjPFile outf,
AjBool full
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| AjBool | full | Input | Full report (usually ajFalse) |
| void | | RETURN | |
Input
| full: | (Input) | Full report (usually ajFalse) |
Input & Output
Returns
Description
Reports the internal data structures
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the obo term output format internals as wikitext
Synopsis
Prototype
void ajObooutprintWiki (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the obo term output format internals as wikitext
See Also
See other functions in this section
Availability
In release 6.4.0
Values for output formats
Functions: ajObooutformatFind ajObooutformatTest
Looks for the specified format(s) in the internal definitions and
returns the index.
Sets iformat as the recognised format, and returns ajTrue.
Synopsis
Prototype
AjBool ajObooutformatFind (
const AjPStr format,
ajint* iformat
);
| Type | Name | Read/Write | Description |
|---|
| const AjPStr | format | Input | Format required. |
| ajint* | iformat | Output | Index |
| AjBool | | RETURN | ajTrue on success. |
Input
| format: | (Input) | Format required. |
Output
Returns
| AjBool: | ajTrue on success. |
Description
Looks for the specified format(s) in the internal definitions and
returns the index.
Sets iformat as the recognised format, and returns ajTrue.
See Also
See other functions in this section
Availability
In release 6.4.0
Tests whether a named OBO output format is known
Synopsis
Prototype
AjBool ajObooutformatTest (
const AjPStr format
);
| Type | Name | Read/Write | Description |
|---|
| const AjPStr | format | Input | Format |
| AjBool | | RETURN | ajTrue if formats was accepted |
Input
Returns
| AjBool: | ajTrue if formats was accepted |
Description
Tests whether a named OBO output format is known
See Also
See other functions in this section
Availability
In release 6.4.0
Functions to initialise and clean up internals
Functions: ajObooutExit
Cleans up obo term outputinternal memory
Synopsis
Prototype
void ajObooutExit (
void
);
| Type | Name | Read/Write | Description |
|---|
| void | | RETURN | |
Returns
Description
Cleans up obo term outputinternal memory
See Also
See other functions in this section
Availability
In release 6.4.0