PAINSFilter

Complexity

Total Complexity

3

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	_load_pains()	0	13	2
A	__init__()	0	13	1

#! /usr/bin/env python
#
# Copyright (C) 2016 Rich Lewis <rl403@cam.ac.uk>
# License: 3-clause BSD

"""
# skchem.filters.smarts

Module defines SMARTS filters.
"""

from rdkit import RDConfig

The import rdkit could not be resolved.

import os
import pandas as pd

The import pandas could not be resolved.

from .base import Filter
from ..core import Mol


class SMARTSFilter(Filter):

    """ Filter a molecule based on smarts.

    Examples:

        >>> import skchem

        >>> data = [
        ...         skchem.Mol.from_smiles('CC', name='ethane'),
        ...         skchem.Mol.from_smiles('c1ccccc1', name='benzene'),
        ...         skchem.Mol.from_smiles('c1ccccc1-c2c(C=O)ccnc2', name='bg')
        ... ]

        >>> f = skchem.filters.SMARTSFilter({'benzene': 'c1ccccc1',
        ...                                  'pyridine': 'c1ccccn1',
        ...                                  'acetyl': 'C=O'})
        >>> f.transform(data, agg=False)
                acetyl benzene pyridine
        ethane   False   False    False
        benzene  False    True    False
        bg       True    True     True

        >>> f.transform(data)
        ethane     False
        benzene     True
        bg         True
        dtype: bool

        >>> f.filter(data)
        benzene                <Mol: c1ccccc1>
        bg        <Mol: O=Cc1ccncc1-c1ccccc1>
        Name: structure, dtype: object

        >>> f.agg = all
        >>> f.filter(data)
        bg    <Mol: O=Cc1ccncc1-c1ccccc1>
        Name: structure, dtype: object
    """

    def __init__(self, smarts, agg='any', merge_hs=True, n_jobs=1,

Too many arguments (6/5)

                 verbose=True):

        """ Initialize a `SMARTSFilter` object.

        Args:
            smarts (pd.Series or dict):
                A series of SMARTS to use in the filter.
            agg (str or callable):
                Option specifying the mode of the filter:
                - 'any': If any of the substructures are in molecule.
                - 'all': If all of the substructures are in molecule.
            n_jobs (int):
                The number of processes to run the filter in.
            verbose (bool):
                Whether to output a progress bar.

        """

        self.merge_hs = merge_hs

        def read_smarts(s):

The name s does not conform to the argument naming conventions ([a-z_][a-z0-9_]{2,30}$).

This function should have a docstring.

            if isinstance(s, str):
                return Mol.from_smarts(s, mergeHs=self.merge_hs)

The Class Mol does not seem to have a member named from_smarts.

            else:
                return s

        self.smarts = pd.Series(smarts).apply(read_smarts)
        super(SMARTSFilter, self).__init__(agg=agg, n_jobs=n_jobs,
                                           verbose=verbose)

    def _transform_mol(self, mol):

This method seems to be hidden by an attribute defined in skchem.filters.base on line 174.

        return self.smarts.apply(lambda smarts: smarts in mol).values

    @property
    def columns(self):
        return self.smarts.index


class PAINSFilter(SMARTSFilter):

    """ Whether a molecule passes the Pan Assay INterference (PAINS) filters.

    These are supplied with RDKit, and were originally proposed by Baell et al.

    Attributes:
        _pains (pd.Series): a series of smarts template molecules.

    References:
        [The original paper](http://dx.doi.org/10.1021/jm901137j)

    Examples:

        Basic usage as a function on molecules:

        >>> import skchem
        >>> benzene = skchem.Mol.from_smiles('c1ccccc1', name='benzene')
        >>> pf = skchem.filters.PAINSFilter()
        >>> pf.transform(benzene)
        True
        >>> catechol = skchem.Mol.from_smiles('Oc1c(O)cccc1', name='catechol')
        >>> pf.transform(catechol)
        False

        >>> res = pf.transform(catechol, agg=False)
        >>> res[res]
        names
        catechol_A(92)    True
        Name: PAINSFilter, dtype: bool

        More useful in combination with pandas DataFrames:

        >>> data = [benzene, catechol]
        >>> pf.transform(data)
        benzene      True
        catechol    False
        dtype: bool

        >>> pf.filter(data)
        benzene    <Mol: c1ccccc1>
        Name: structure, dtype: object
    """

    _pains = None

    def __init__(self, n_jobs=1, verbose=True):

        """ Initialize a `PAINSFilter` object.

        Args:
            n_jobs (int):
                The number of procesess to run the filter in.
            verbose (bool):
                Whether to output a progress bar.
        """

        super(PAINSFilter, self).__init__(self._load_pains(), agg='not any',
                                          n_jobs=n_jobs, verbose=verbose)

    @classmethod
    def _load_pains(cls):

        """ Load  PAINS into a `pd.Series` and cache as class attribute. """

        if cls._pains is None:
            path = os.path.join(RDConfig.RDDataDir, 'Pains', 'wehi_pains.csv')
            pains = pd.read_csv(path, names=['pains', 'names'])
            pains['names'] = pains.names.str.lstrip('<regId=').str.rstrip('>')
            pains = pains.set_index('names').pains.apply(Mol.from_smarts,

The Class Mol does not seem to have a member named from_smarts.

                                                         mergeHs=True)
            cls._pains = pains
        return cls._pains