Public Member Functions
	__init__ (self, aaindex_files=None)

	keys (self)

	values (self)

	__getitem__ (self, key)

Data Fields
	files_to_load

	aaindex_entries

Protected Member Functions
	_LoadAll (self)

	_Load (self)

Detailed Description

Provides access to data from the amino acid index database (aaindex):

Kawashima, S. and Kanehisa, M.; AAindex: amino acid index database. 
Nucleic Acids Res. 28, 374 (2000). 

Files are available `here <https://www.genome.jp/aaindex/>`_

:param aaindex_files: Paths to aaindex files. If not given, the files
                      aaindex1, aaindex2 and aaindex3 from the specified
                      source are used (Release 9.2, Feb 2017).
:type aaindex_files: :class:`list` of :class:`str`

Definition at line 252 of file aaindex.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		aaindex_files = `None`
	)

Definition at line 265 of file aaindex.py.

Member Function Documentation

◆ getitem()

__getitem__	(	self,
		key
	)

Getter by aaindex accession number (e.g. ANDN920101)

:param key: aaindex accession number
:type key: :class:`str`
:returns: :class:`AAIndexData` object

Definition at line 292 of file aaindex.py.

◆ _Load()

_Load ( self )

protected

Loads and removes first element in self.files_to_load. Returns False
if there is no file to load anymore, True if one is successfully loaded.

Definition at line 314 of file aaindex.py.

◆ _LoadAll()

_LoadAll ( self )

protected

Loads all remaining files specified in self.files_to_load

Definition at line 308 of file aaindex.py.

◆ keys()

keys ( self )

Emulate dict like behvaiour and returns all available keys, accession
numbers respectively. 

:returns: keys (or accession numbers) of all available aaindex entries

Definition at line 275 of file aaindex.py.

◆ values()

values ( self )

Emulate dict like behvaiour and returns all available entries.

:returns: iterable of entries (type :class:`AAIndexData`)

Definition at line 284 of file aaindex.py.

Field Documentation

◆ aaindex_entries

aaindex_entries

Definition at line 273 of file aaindex.py.

◆ files_to_load

files_to_load

Definition at line 268 of file aaindex.py.

The documentation for this class was generated from the following file:

build-dev/stage/lib/python3.11/site-packages/ost/seq/alg/aaindex.py

Public Member Functions

Data Fields

Protected Member Functions