summaryrefslogtreecommitdiff
path: root/README.md
blob: cf1f519da3961c264d8c69a4e65a48a9a626983a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
OpenTox Algorithm
=================

- An [OpenTox](http://www.opentox.org) REST Webservice 
- Implements the OpenTox algorithm API for
    - fminer
    - lazar

REST operations
---------------

    Get a list of all algorithms  GET   /       -                       URIs of algorithms        200
    Get a representation of the   GET   /fminer -                       fminer representation     200,404
    fminer algorithm  
    Get a representation of the   GET   /lazar  -                       lazar representation      200,404
    lazar algorithm   
    Create fminer features        POST  /fminer dataset_uri,            URI for feature dataset   200,400,404,500
                                                feature_uri   
    Create lazar model            POST  /lazar  dataset_uri,            URI for lazar model       200,400,404,500
                                                prediction_feature, 
                                                feature_generation_uri  

Supported MIME formats 
----------------------

- application/rdf+xml (default): read/write OWL-DL
- application/x-yaml: read/write YAML

Examples
--------

### Get the OWL-DL representation of fminer 

    curl http://webservices.in-silico.ch/algorithm/fminer

### Get the OWL-DL representation of lazar 

    curl http://webservices.in-silico.ch/algorithm/lazar

### Create fminer features

    curl -X POST -d dataset_uri={datset_uri} -d prediction_feature={feature_uri} http://webservices.in-silico.ch/algorithm/fminer

(feature_uri specifies the dependent variable, e.g. http://www.epa.gov/NCCT/dsstox/CentralFieldDef.html#ActivityOutcome_CPDBAS_Hamster)

Creates a dataset with fminer features (backbone refinement class representatives from supervised graph mining, see http://www.maunz.de/libfminer-doc/). These features can be used e.g. as structural alerts, as descriptors (fingerprints) for prediction models or for similarity calculations.

### Create lazar model

    curl -X POST -d dataset_uri={datset_uri} -d prediction_feature={feature_uri} -d feature_generation_uri=http://webservices.in-silico.ch/algorithm/fminer http://webservices.in-silico.ch/test/algorithm/lazar

(feaure_uri specifies the dependent variable, e.g. http://www.epa.gov/NCCT/dsstox/CentralFieldDef.html#ActivityOutcome_CPDBAS_Hamster)

[API documentation](http://rdoc.info/github/opentox/algorithm)
--------------------------------------------------------------

Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details.