ajrefseqwrite.c

Datatypes:
AjPOutfile Reference sequence data output
none Miscellaneous functions


Datatype: AjPOutfile

Function is for manipulating reference sequence data objects

Sections:
reference sequence data outputsOutput


AjPOutfile: reference sequence data outputs

These functions write the reference sequence data provided by the first argument

Functions:
ajRefseqoutWriteWrite refseq data in a named format


Function ajRefseqoutWrite

Write refseq data in a named format

Prototype

AjBool ajRefseqoutWrite (
      AjPOutfile outf,
      const AjPRefseq refseq
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPRefseqrefseqInputRefseq data object
AjBool RETURNTrue on success

In release 6.5.0


Datatype: none

Functions to initialise and clean up internals

Sections:
PrintCasts


Section: Print

Printing to a file

Functions:
ajRefseqoutprintBookReports the reference sequence format internals as Docbook text
ajRefseqoutprintHtmlReports the internal data structures
ajRefseqoutprintTextReports the internal data structures
ajRefseqoutprintWikiReports the reference sequence output format internals as wikitext


Function ajRefseqoutprintBook

Reports the reference sequence format internals as Docbook text

Prototype

void ajRefseqoutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0


Function ajRefseqoutprintHtml

Reports the internal data structures

Prototype

void ajRefseqoutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0


Function ajRefseqoutprintText

Reports the internal data structures

Prototype

void ajRefseqoutprintText (
      AjPFile outf,
      AjBool full
);

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

In release 6.5.0


Function ajRefseqoutprintWiki

Reports the reference sequence output format internals as wikitext

Prototype

void ajRefseqoutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

In release 6.5.0


Section: cast

Values for output formats

Functions:
ajRefseqoutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajRefseqoutformatTestTests whether a named refseq output format is known


Function ajRefseqoutformatFind

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

Prototype

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

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

In release 6.5.0


Function ajRefseqoutformatTest

Tests whether a named refseq output format is known

Prototype

AjBool ajRefseqoutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

In release 6.5.0


Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajRefseqoutExitCleans up reference sequence output internal memory


Function ajRefseqoutExit

Cleans up reference sequence output internal memory

Prototype

void ajRefseqoutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

In release 6.5.0