ajtaxwrite.c

Datatypes:
AjPFile Taxonomy data output
none Miscellaneous functions


Datatype: AjPFile

Function is for manipulating taxonomy data objects

Sections:
taxonomy data outputsOutput


AjPFile: taxonomy data outputs

These functions write the taxonomy data provided by the first argument

Functions:
ajTaxoutWriteWrite a taxon in a named format


Function ajTaxoutWrite

Write a taxon in a named format

Prototype

AjBool ajTaxoutWrite (
      AjPOutfile outf,
      const AjPTax tax
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPTaxtaxInputTaxon object
AjBool RETURNTrue on success

From EMBOSS 6.4.0


Datatype: none

Functions to initialise and clean up internals

Sections:
PrintCasts


Section: Print

Printing to a file

Functions:
ajTaxoutprintBookReports the taxonomy format internals as Docbook text
ajTaxoutprintHtmlReports the internal data structures
ajTaxoutprintTextReports the internal data structures
ajTaxoutprintWikiReports the taxonomy output format internals as wikitext


Function ajTaxoutprintBook

Reports the taxonomy format internals as Docbook text

Prototype

void ajTaxoutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajTaxoutprintHtml

Reports the internal data structures

Prototype

void ajTaxoutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajTaxoutprintText

Reports the internal data structures

Prototype

void ajTaxoutprintText (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull report (usually ajFalse)
void RETURN

From EMBOSS 6.4.0


Function ajTaxoutprintWiki

Reports the taxonomy output format internals as wikitext

Prototype

void ajTaxoutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Section: cast

Values for output formats

Functions:
ajTaxoutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajTaxoutformatTestTests whether a named taxon output format is known


Function ajTaxoutformatFind

Looks for the specified format(s) in the internal definitions and returns the index.

Prototype

AjBool ajTaxoutformatFind (
      const AjPStr format,
      ajint* iformat
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat required.
ajint*iformatOutputIndex
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0


Function ajTaxoutformatTest

Tests whether a named taxon output format is known

Prototype

AjBool ajTaxoutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

From EMBOSS 6.4.0


Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajTaxoutExitCleans up taxonomy output internal memory


Function ajTaxoutExit

Cleans up taxonomy output internal memory

Prototype

void ajTaxoutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0