lXtractor 0.1.5

Feature extraction library for sequences and structures

lXtractor

Introduction

lXtractor is a toolbox devoted to feature extraction from macromolecular sequences and structures. It's tailored towards creating shareable local data collections anchored to a reference sequence-based object: a single sequence, MSA, or an HMM model. Currently, it doesn't define any unique algorithms, aiming at simplicity and transparency. It simply provides a (hopefully) convenient interface simplifying mundane tasks, such as fetching the data, extracting domains, mapping sequences, and computing sequential and structural variables. Sequences and structures anchored to a single reference object have a benefit of interpretability in downstream applications, such as fitting interpretable ML models.

Installation

lXtractor requires python>=3.10 installed on a Unix system and is installable via pip

pip install lXtractor

We encourage users to first create a virtual environment via conda or mamba.

Usage

lXtractor is designed to be flexible and its usage is defined by the initial hypothesis or a reference object that one wants to extrapolate towards the existing sequences or structures. Below, we'll provide a very abstract description of what this package is intended for.

In creating data collections, one could define the following steps::

1. Assemble the data.
2. Map reference object to assembled entries' sequences.
3. Filter hits.
4. Define and calculate variables -- sequence or structure descriptors.
5. Save the data for later usage or modifications.

lXtractor defines objects and routines helpful throughout this process. Namely, PDB, SIFTS, AlphaFold, fetch_uniprot() can aid in the first step. Then, Alignment and PyHMMer can facilitate step 2. At the end of the step 2 one will get a collection of Chain*-type objects. If working with sequence-only collections, these are going to be ChainSequence objects. For structure-only data, these are going to be ChainStructure containers, embedding ChainSequence and GenericStructure objects. Finally, dealing with mappings between canonical sequence associated with a group of structures will result in Chain objects.

ChainList wraps Chain*-type objects into a list-like collection with useful operations allowing to quickly filter and bulk-modify Chain*-type objects. Thus, filtering typically comes down to using ChainList.filter() method that accepts a Callable[Chain*, bool] and returns a filtered ChainList. One can save/load the collected objects using ChainIO and proceed with the feature extraction.

lXtractor defines various sequence and structure variables. Variable-related operations are handled by GenericCalculator and Manager classes. The former defines the calculation strategy and how the calculations are parallelized, while the latter handles the calculations and aggregates the results into a pandas DataFrame.

As a result, one is left with a collection of Chain*-type objects and a table with calculated variables. In addition, one can store the calculated variables within the objects themselves, although we currently do not encourage this practice.

lXtractor is in the experimental stage and under active development. Thus, objects' interfaces may change.

For the time being, one can check the examples of

1. finding sequence determinants of tyrosine and serine-threonine kinases and
2. a protocol to build a complete structural collection of protein kinase domains.

More examples are to come in the future, so stay tuned. If you know a good example to apply lXtractor, feel free to raise an issue or reach out [e-mail].