conkit.core.contactfile module¶
ContactFile container used throughout ConKit
-
class
ContactFile
(id)[source]¶ Bases:
conkit.core.entity.Entity
A contact file object representing a single prediction file
The contact file class represents a data structure to hold all predictions with a single contact map file. It contains functions to store, manipulate and organise contact maps.
Examples
>>> from conkit.core import ContactMap, ContactFile >>> contact_file = ContactFile("example") >>> contact_file.add(ContactMap("foo")) >>> contact_file.add(ContactMap("bar")) >>> print(contact_file) ContactFile(id="example" nmaps=2)
The author of the
ContactFile
Type: str
-
method
¶ The
ContactFile
-specific methodType: list, str
-
remark
¶ The
ContactFile
-specific remarksType: list, str
-
top_map
¶ The first
ContactMap
entry inContactFile
Type: ContactMap
-
author
-
method
The
ContactFile
-specific method
-
remark
The
ContactFile
-specific remarks
-
sort
(kword, reverse=False, inplace=False)[source]¶ Sort the
ContactFile
Parameters: Returns: The reference to the
ContactMap
, regardless of inplaceReturn type: Raises: ValueError
– kword not inContactFile
-
target
-
top_map
The first
ContactMap
entry