Skip to content

Latest commit

 

History

History
127 lines (90 loc) · 7.15 KB

README.md

File metadata and controls

127 lines (90 loc) · 7.15 KB

AMBIT applicability domain estimation examples

ambit-model package is an implementation of methods described in

The appdomain project is a command line application, demonstrating how to use ambit-model package. Alternatively, the applicability domain algorithms are implemented in Ambit Discovery desktop application as well as REST web services in Ambit web application.

The applicability domain is estimated based on the data in the training set only (independent of the model). The applicability domain estimation is reported for the test set. You may specify one and the same file as both test and training set. The input file formats are recognised by extension (e.g. .csv, .sdf, .cml).

The result file consists of all the properties in the test set, the predicted metric by the applicability domain method and a flag indicating if the molecule is out of domain ( 0 - in domain, 1 - out of domain). The output file tipe is recognised by extension (e.g. .csv, .sdf, .cml).

Run

>java -jar ambit-appdomain-jar-with-dependencies.jar -h
Ambit applicability domain estimation by ambit-models package
usage: net.idea.example.ambit.appdomain.MainApp
 -d,--demo                 Training and test CSV files from PubMed:1732103

 -f,--descriptors <list>   Comma delimited list of field names (as in the
                           input files) to be used as descriptors.
                           Example -f log_P,eLumo,eHomo,IL
 -h,--help                 Ambit applicability domain estimation by
                           ambit-models package
 -m,--method <method>      Applicability domain estimation method:
                           _modeRANGE   (PCARanges)
                           _modeLEVERAGE        (Leverage)
                           _modeEUCLIDEAN       (Euclidean distance)
                           _modeCITYBLOCK       (City-block distance)
                           _modeMAHALANOBIS     (Mahalanobis distance)
                           _modeDENSITY (Probability density)
                           _modeFINGERPRINTS_CONSENSUS
                           (Tanimoto Fingerprints (consensus))
                           _modeFINGERPRINT_MISSINGFRAGMENTS
                           (Tanimoto Fingerprints (consensus))
                           Example:
                           -m _modeFINGERPRINTS Default value:  _modeFINGERPRINTS_CONSENSUS
 -o,--output <output>      Output file (CSV,SDF)
 -r,--threshold <value>    1.0 : all compounds from training set
                           considered in the applicability domain (default); 0.9 : 90% of compounds
                           from training set
 -s,--test <file>          Test file (CSV,SDF)
 -t,--training <file>      Training file (CSV,SDF)

Example 1

Reads the demo files and apply applicability domain by Tanimoto consensus fingerprint, assuming all of the training set compounds are in the app.domain. Results saved in result.sdf file. :

java -jar example-ambit-appdomain-jar-with-dependencies.jar	-m _modeFINGERPRINTS_CONSENSUS -d mutagenicity -o result.csv

Example 2

Reads the demo files and apply applicability domain by probability density estimation, assuming all of the training set compounds are in the app.domain. :

java -jar example-ambit-appdomain-jar-with-dependencies.jar	-m _modeDENSITY -d mutagenicity

Example 3

Reads training and test CSV files and apply applicability domain by probability density estimation, assuming 90% of the training set compounds are in the app.domain. :

java -jar example-ambit-appdomain-jar-with-dependencies.jar	-m _modeDENSITY -t Debnath_smiles.csv -s Glende_smiles.csv -f log_P,eLumo,eHomo,IL -r 0.9

Example files

Support

Download

Command line application

Maven artifact

<dependency>
    <groupId>net.idea.examples.ambit</groupId>
    <artifactId>ambit-appdomain</artifactId>
    <version>2.0.0</version>
</dependency>
<repository>
	<id>nexus-idea-releases</id>
	<url>https://nexus.ideaconsult.net/content/repositories/releases</url>
</repository>

Build

>mvn clean package

The executable file is at target/ambit-appdomain-jar-with-dependencies.jar

>java -jar target/ambit-appdomain-jar-with-dependencies.jar -h