Skip to main content

Module methods

Module methods 

Source
Expand description

A methods paragraph and the reference list of a run, for dima cite --from and the GUI’s “Export methods & references” (D89): built from the run’s recorded parameters and its run.references — and, when given, from the conserved sequences computed from it and their references — so it states exactly what was done and cites exactly what was used.

Structs§

Cited
What a methods text and reference list describe: an analysis, the conserved sequences computed from one, both, or neither (DiMA itself).

Enums§

CitationFormat
Output formats of a reference list.

Functions§

hcs_sentence
A methods sentence for conserved sequences.
methods_text
The methods text and its numbered references, as plain text: what dima cite --from prints and the desktop app’s “Methods & references” export writes. None when nothing is cited (no results and no conserved sequences).
references
The reference list of what is cited (DiMA itself when nothing is).
sentence
A methods paragraph describing the run.