|
| def | __init__ (self, query, hhsuite_root, hhblits_bin=None, working_dir=None) |
| |
| def | BuildQueryMSA (self, nrdb, options={}, a3m_file=None, assign_ss=True) |
| |
| def | AssignSSToA3M (self, a3m_file) |
| |
| def | A3MToProfile (self, a3m_file, hhm_file=None) |
| |
| def | A3MToCS (self, a3m_file, cs_file=None, options={}) |
| |
| def | Cleanup (self) |
| |
| def | CleanupFailed (self) |
| |
| def | Search (self, a3m_file, database, options={}, prefix='') |
| |
Initialise a new HHblits "search" for the given query. Query may either
be a :class:`~ost.seq.SequenceHandle` or a string. In the former case, the
query is the actual query sequence, in the latter case, the query is the
filename to the file containing the query.
:param query: Query sequence as file or sequence.
:type query: :class:`~ost.seq.SequenceHandle` or :class:`str`
:param hhsuite_root: Path to the top-level directory of your hhsuite
installation.
:type hhsuite_root: :class:`str`
:param hhblits_bin: Name of the hhblits binary. Will only be used if
:attr:`hhsuite_root`:file:`/bin/hhblits` does not exist.
:type hhblits_bin: :class:`str`
:param working_dir: Directory for temporary files. Will be created if not
present but **not** automatically deleted.
:type working_dir: :class:`str`
Definition at line 464 of file hhblits3.py.
| def A3MToCS |
( |
|
self, |
|
|
|
a3m_file, |
|
|
|
cs_file = None, |
|
|
|
options = {} |
|
) |
| |
Converts the A3M alignment file to a column state sequence file. If
cs_file is not given, the output file will be set to
<:attr:`a3m_file`-basename>.seq219.
If the file was already produced, the existing file path is returned
without recomputing it.
:param a3m_file: Path to input MSA as produced by :meth:`BuildQueryMSA`
:type a3m_file: :class:`str`
:param cs_file: Output file name (may be omitted)
:type cs_file: :class:`str`
:param options: Dictionary of options to *cstranslate*, one "-" is added
in front of every key. Boolean True values add flag
without value.
:type options: :class:`dict`
:return: Path to the column state sequence file
:rtype: :class:`str`
Definition at line 681 of file hhblits3.py.
| def BuildQueryMSA |
( |
|
self, |
|
|
|
nrdb, |
|
|
|
options = {}, |
|
|
|
a3m_file = None, |
|
|
|
assign_ss = True |
|
) |
| |
Builds the MSA for the query sequence.
The produced A3M file can be parsed by :func:`ParseA3M`. If the file was
already produced, hhblits is not called again and the existing file path
is returned (neglecting the *assign_ss* flag!!!).
:param nrdb: Database to be align against; has to be an hhblits database
:type nrdb: :class:`str`
:param options: Dictionary of options to *hhblits*, one "-" is added in
front of every key. Boolean True values add flag without
value. Merged with default options
{'cpu': 1, 'n': 1, 'e': 0.001}, where 'n' defines the
number of iterations and 'e' the E-value cutoff for
inclusion of sequences in result alignment.
:type options: :class:`dict`
:param a3m_file: a path of a3m_file to be used, optional
:type a3m_file: :class:`str`
:param assign_ss: HHblits does not assign predicted secondary structure
by default. You can optionally assign it with the
addss.pl script provided by the HH-suite. However,
your HH-suite installation requires you to specify
paths to PSIRED etc. We refer to the HH-suite user
guide for further instructions. Assignment is done
by calling :func:`HHblits.AssignSSToA3M`
:type assign_ss: :class:`bool`
:return: The path to the A3M file containing the MSA
:rtype: :class:`str`
Definition at line 523 of file hhblits3.py.
| def Search |
( |
|
self, |
|
|
|
a3m_file, |
|
|
|
database, |
|
|
|
options = {}, |
|
|
|
prefix = '' |
|
) |
| |
Searches for templates in the given database. Before running the search,
the hhm file is copied. This makes it possible to launch several hhblits
instances at once. Upon success, the filename of the result file is
returned. This file may be parsed with :func:`ParseHHblitsOutput`.
:param a3m_file: Path to input MSA as produced by :meth:`BuildQueryMSA`
:type a3m_file: :class:`str`
:param database: Search database, needs to be the common prefix of the
database files
:type database: :class:`str`
:param options: Dictionary of options to *hhblits*, one "-" is added in
front of every key. Boolean True values add flag without
value. Merged with default options {'cpu': 1, 'n': 1},
where 'n' defines the number of iterations.
:type options: :class:`dict`
:param prefix: Prefix to the result file
:type prefix: :class:`str`
:return: The path to the result file
:rtype: :class:`str`
Definition at line 747 of file hhblits3.py.
