embsig


Data type EmbPSigpos

Nucleus Sigpos object.

Holds data for compiled signature position

EmbPSigpos is implemented as a pointer to a C data structure.

Alias name(s)

Name
EmbSSigpos
EmbOSigpos

Attributes

NameTypeDescription
gsizajuint*Gap sizes
gpenfloat*Gap penalties
subsfloat*Residue match values
ngapsajuintNo. of gaps
Paddingchar[4]Padding to alignment boundary

Constructor(s)

NameDescription
embSigposNewDefault Sigdat object constructor

Destructor(s)

NameDescription
embSigposDelDefault Sigdat object destructor


Data type EmbPSigdat

Nucleus Sigdat object.

Holds empirical data for an (uncompiled) signature position. Important: Functions which manipulate this structure rely on the data in the gap arrays (gsiz and grfq) being filled in order of increasing gap size.

EmbPSigdat is implemented as a pointer to a C data structure.

Alias name(s)

Name
EmbSSigdat
EmbOSigdat

Attributes

NameTypeDescription
ridsAjPCharResidue id's
rfrqAjPUintResidue frequencies
nresajuintNo. diff. types of residue
nenvajuintNo. diff. types of environment
eidsAjPStr*Environment id's
efrqAjPUintEnvironment frequencies
gsizAjPUintGap sizes
gfrqAjPUintFrequencies of gaps of each size
ngapajuintNo. diff. sizes of empirical gap
wsizajuintWindow size for this gap

Constructor(s)

NameDescription
embSigdatNewDefault Sigdat object constructor

Destructor(s)

NameDescription
embSigdatDelDefault Sigdat object destructor


Data type EmbPSignature

Nucleus Signature object.

EmbPSignature is implemented as a pointer to a C data structure.

Alias name(s)

Name
EmbSSignature
EmbOSignature

Attributes

NameTypeDescription
TypeajuintType, either ajSCOP (1) or ajCATH (2) for domain signatures, or ajLIGAND (3) for ligand signatures.
TypesigajuintType, either aj1D (1) or aj3D (2) for sequence or structure-based signatures respectively.
ClassAjPStrSCOP classification.
ArchitectureAjPStrCATH classification.
TopologyAjPStrCATH classification.
FoldAjPStrSCOP classification.
SuperfamilyAjPStrSCOP classification.
FamilyAjPStrSCOP classification.
Sunid_FamilyajuintSCOP sunid for family.
nposajuintNo. of signature positions.
posEmbPSigpos*Array of derived data for puropses of alignment.
datEmbPSigdat*Array of empirical data.
IdAjPStrProtein id code.
DomidAjPStrDomain id code.
LigidAjPStrLigand id code.
DescAjPStrDescription of ligand (ajLIGAND only)
nsajuintNo. of sites (ajLIGAND only)
snajuintSite number (ajLIGAND only)
npajuintNo. of patches (ajLIGAND only)
pnajuintPatch number (ajLIGAND only)
minpatchajuintMax. patch size (residues) (ajLIGAND only)
maxgapajuintMin. gap distance (residues) (ajLIGAND only)

Constructor(s)

NameDescription
embSignatureNewDefault Signature constructor

Destructor(s)

NameDescription
embSignatureDelDefault Signature destructor

Output

NameDescription
embSignatureWriteWrite signature to file.

Input

NameDescription
embSignatureReadNewConstruct a Signature object from reading a file in embl-like format (see documentation for the DOMAINATRIX "sigscan" application).

Output

NameDescription
embSignatureWriteWrite a Signature object to a file in embl-like format (see documentation for the DOMAINATRIX "sigscan" application).

Input

NameDescription
embSignatureHitsReadConstruct a Hitlist object from reading a signature hits file (see documentation for the DOMAINATRIX "sigscan" application).

Output

NameDescription
embSignatureHitsWriteWrites a list of Hit objects to a signature hits file (see documentation for the DOMAINATRIX "sigscan" application).

Modifier(s)

NameDescription
embSignatureCompileCompiles a Signature object. The signature must first have been allocated by using the embSignatureNew function.

Operator(s)

NameDescription
embSignatureAlignSeqPerforms an alignment of a signature to a protein sequence. The signature must have first been compiled by calling embSignatureCompile. Write a Hit object with the result.
embSignatureAlignSeqallPerforms an alignment of a signature to protein sequences. The signature must have first been compiled by calling embSignatureCompile. Write a list of Hit objects with the result.


Data type EmbPHit

Nucleus hit object.

Holds data associated with a protein / domain sequence that is generated and or manipulated by the EMBOSS applications seqsearch, seqsort, and sigscan.

EmbPHit is implemented as a pointer to a C data structure.

Alias name(s)

Name
EmbSHit
EmbOHit

Attributes

NameTypeDescription
SeqAjPStrSequence as string.
StartajuintStart of sequence or signature alignment relative to full length swissprot sequence, this is an index so starts at 0.
EndajuintEnd of sequence or signature alignment relative to full length swissprot sequence, this is an index so starts at 0.
AccAjPStrAccession number of sequence entry.
SprAjPStrSwissprot code of sequence entry.
DomAjPStrSCOP or CATH database identifier code of entry.
RankajuintRank order of hit
ScorefloatScore of hit
EvalfloatE-value of hit
Pvalfloatp-value of hit
TypeobjAjPStrPrimary (objective) classification of hit.
TypesbjAjPStrSecondary (subjective) classification of hit
ModelAjPStrString for model type if used, one of PSIBLAST, HMMER, SAM, SPARSE, HENIKOFF or GRIBSKOV
AlgAjPStrAlignment, e.g. of a signature to the sequence
GroupAjPStrGrouping of hit, e.g. 'REDUNDANT' or 'NON_REDUNDANT'
TargetAjBoolUsed for garbage collection.
Target2AjBoolAlso used for garbage collection.
SigEmbPSignaturePointer to signature object for which hit
PriorityAjBoolAlso used for garbage collection.
Paddingchar[4]Padding to alignment boundary was generated. Used as a pointer only - memory is never freed or allocated to it.

Constructor(s)

NameDescription
embHitNewDefault Hit constructor
embHitReadFastaConstruct Hit object from reading the next entry from a file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).

Destructor(s)

NameDescription
embHitDelDefault Hit destructor

Assignment(s)

NameDescription
embHitMergeCreate new Hit from merging two Hit objects

Operator(s)

NameDescription
embMatchScoreSort Hit objects by Score element.
embMatchinvScoreSort (inverted order) Hit objects by Score element.
embMatchLigidSort Hit objects by Ligid element in Sig element.
embMatchSort Hit objects by Ligid element in Sig element.
embHitsOverlapChecks for overlap between two Hit objects.


Data type EmbPHitlist

Nucleus hitlist object.

Holds an array of hit structures and associated SCOP classification records.

EmbPHitlist is implemented as a pointer to a C data structure.

Alias name(s)

Name
EmbSHitlist
EmbOHitlist

Attributes

NameTypeDescription
ClassAjPStrSCOP classification.
ArchitectureAjPStrCATH classification.
TopologyAjPStrCATH classification.
FoldAjPStrSCOP classification.
SuperfamilyAjPStrSCOP classification.
FamilyAjPStrSCOP classification.
ModelAjPStrSCOP classification.
Sunid_FamilyajuintSCOP sunid for family.
PriorityAjBoolTrue if the Hitlist is high priority.
hitsEmbPHit*Array of hits.
TypeajuintDomain type, either ajSCOP (1) or ajCATH (2).
NajuintNo. of hits.

Constructor(s)

NameDescription
embHitlistNewDefault Hitlist constructor

Destructor(s)

NameDescription
embHitlistDelDefault Hitlist destructor

Operator(s)

NameDescription
embHitlistMatchFoldSort Hitlist objects by Fold element

Input

NameDescription
embHitlistReadConstruct Hitlist object from reading the next entry from a file in embl-like format (see documentation for the DOMAINATRIX "seqsearch" application).

Constructor(s)

NameDescription
embHitlistReadFastaConstruct Hitlist object from reading the next entry from a file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).

Input

NameDescription
embHitlistReadNodeConstruct Hitlist object from reading a specific entry from a file in embl-like format (see documentation for the DOMAINATRIX "seqsearch" application).

Constructor(s)

NameDescription
embHitlistReadNodeFastaConstruct Hitlist object from reading a specific entry from a file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).

Output

NameDescription
embHitlistWriteWrite Hitlist to file in embl-like format (see documentation for the DOMAINATRIX "seqsearch" application).
embHitlistWriteSubsetWrite a subset of a Hitlist to file in embl-like format (see documentation for the DOMAINATRIX "seqsearch" application).
embHitlistWriteFastaWrite Hitlist to file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).
embHitlistWriteSubsetFastaWrite a subset of a Hitlist to file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).
embHitlistWriteHitFastaWrite a single Hit from a Hitlist to file in extended FASTA format (see documentation for the DOMAINATRIX "seqsearch" application).

Operator(s)

NameDescription
embHitlistClassifyClassifies a list of signature-sequence hits (held in a Hitlist object) according to list of target sequences (a list of Hitlist objects).