summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 33 insertions, 20 deletions
diff --git a/README.md b/README.md
index cf1f519..0eb641c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
OpenTox Algorithm
=================
-- An [OpenTox](http://www.opentox.org) REST Webservice
+- An [OpenTox](http://www.opentox.org) REST Webservice
- Implements the OpenTox algorithm API for
- fminer
- lazar
@@ -9,18 +9,26 @@ OpenTox Algorithm
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
+ Get a list of all algorithms GET / - URIs of algorithms 200
+ Get a representation of the GET /fminer/ - fminer representation 200,404
+ fminer algorithms
+ Get a representation of the GET /fminer/bbrc - bbrc representation 200,404
+ bbrc algorithm
+ Get a representation of the GET /fminer/last - last representation 200,404
+ last algorithm
+ Get a representation of the GET /lazar - lazar representation 200,404
+ lazar algorithm
+ Create bbrc features POST /fminer/bbrc dataset_uri, URI for feature dataset 200,400,404,500
+ feature_uri,
+ min_frequency
+ Create last features POST /fminer/last dataset_uri, URI for feature dataset 200,400,404,500
+ feature_uri,
+ min_frequency
+ 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
@@ -29,19 +37,25 @@ Supported MIME formats
Examples
--------
-### Get the OWL-DL representation of fminer
+### Get the OWL-DL representation of fminer
curl http://webservices.in-silico.ch/algorithm/fminer
-### Get the OWL-DL representation of lazar
+### Get the OWL-DL representation of lazar
curl http://webservices.in-silico.ch/algorithm/lazar
-### Create fminer features
+### Create [BBRC](http://bbrc.maunz.de) features
- curl -X POST -d dataset_uri={datset_uri} -d prediction_feature={feature_uri} http://webservices.in-silico.ch/algorithm/fminer
+ curl -X POST -d dataset_uri={datset_uri} -d prediction_feature={feature_uri} -d min_frequency={min_frequency} http://webservices.in-silico.ch/algorithm/fminer/bbrc
-(feature_uri specifies the dependent variable, e.g. http://www.epa.gov/NCCT/dsstox/CentralFieldDef.html#ActivityOutcome_CPDBAS_Hamster)
+feature_uri specifies the dependent variable from the dataset.
+
+### Create [LAST-PM](http://last-pm.maunz.de) features
+
+ curl -X POST -d dataset_uri={datset_uri} -d prediction_feature={feature_uri} -d min_frequency={min_frequency} http://webservices.in-silico.ch/algorithm/fminer/last
+
+feature_uri specifies the dependent variable from the dataset.
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.
@@ -49,10 +63,9 @@ Creates a dataset with fminer features (backbone refinement class representative
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)
+feature_uri specifies the dependent variable from the dataset
[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.
-