Compound
This module contains the Compound types, constructors and accessors for those types. The procedures in this module will be used in almost any possible use-case for nimna.
Example usage
Those are the ways Compounds can be created.
import nimna let monomer = compound"some sequence ..." dimer = dimer("some sequence ...", "some other sequence ...") alsoADimer = compound"some sequence ...&some other sequence ..."
Procs
proc isDimer(c: Compound): bool {.
raises: [], tags: [].}proc compound(sequence: string): Compound {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound from a sequence string.
proc compound(sequences: openArray[string]): CompoundComparative {.
raises: [Exception, Exception], tags: [RootEffect].}- Creates a Compound from a sequence alignment stored as a set of sequences.
proc compound(al: Alignment): CompoundComparative {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound from an Alignment.
proc dimer(sequence1, sequence2: string): Compound {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound containing a dimer.
proc compound2D(sequence, reference1, reference2: string): Compound2D {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound for 2DFold from a sequence string, together with two reference structures.
proc compound(sequence: string; settings: Settings): Compound {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound from a sequence string with Settings.
proc dimer(sequence1, sequence2: string; settings: Settings): Compound {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound containing a dimer.
proc compound2D(sequence, reference1, reference2: string; settings: Settings): Compound2D {.
raises: [Exception], tags: [RootEffect].}- Creates a Compound from a sequence string with Settings.