summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristoph Helma <helma@in-silico.ch>2011-03-28 18:45:00 +0200
committerChristoph Helma <helma@in-silico.ch>2011-03-28 18:45:00 +0200
commit691b1f0b9cf377ae5559d330d746ff73b941e57f (patch)
tree14553bcd41f072209e4f1a5790146866ca21d004
parenta31facccdff1c6b47b872263f202fb706c10f540 (diff)
parent7a622f01d9b965adb6fe280c716db3621709083a (diff)
Merge branch 'master' of github.com:opentox/algorithmv1.0.6
-rw-r--r--README.md52
1 files changed, 33 insertions, 19 deletions
diff --git a/README.md b/README.md
index 0eb641c..f5679fa 100644
--- a/README.md
+++ b/README.md
@@ -9,24 +9,25 @@ 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
+ 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
+ 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
+ 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
+ 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
+ Create bbrc features POST /fminer/bbrc dataset_uri, URI for feature dataset 200,400,404,500
+ feature_uri,
+ [min_frequency=5 per-mil],
+ [backbone=true]
+ Create last features POST /fminer/last dataset_uri, URI for feature dataset 200,400,404,500
+ feature_uri,
+ [min_frequency=8 %],
+ Create lazar model POST /lazar dataset_uri, URI for lazar model 200,400,404,500
+ prediction_feature,
+ feature_generation_uri
Supported MIME formats
----------------------
@@ -45,19 +46,32 @@ Examples
curl http://webservices.in-silico.ch/algorithm/lazar
-### Create [BBRC](http://bbrc.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/bbrc
+The following creates datasets with backbone refinement class representatives or latent structure patterns, using supervised graph mining, see http://cs.maunz.de. These features can be used e.g. as structural alerts, as descriptors (fingerprints) for prediction models or for similarity calculations.
+
+### Create the full set of frequent and significant subtrees
+
+ curl -X POST -d dataset_uri={datset_uri} -d prediction_feature={feature_uri} -d min_frequency={min_frequency} -d "backbone=false" http://webservices.in-silico.ch/algorithm/fminer/bbrc
feature_uri specifies the dependent variable from the dataset.
+backbone=false reduces BBRC mining to frequent and correlated subtree mining (much more descriptors are produced).
+
+### Create [BBRC](http://bbrc.maunz.de) features, recommended for large and very large datasets.
-### 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/bbrc
+
+feature_uri specifies the dependent variable from the dataset.
+Please click [here](http://bbrc.maunz.de#usage) for more guidance on usage.
+
+### Create [LAST-PM](http://last-pm.maunz.de) descriptors, recommended for small to medium-sized datasets.
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.
+feature_uri specifies the dependent variable from the dataset.
+Please click [here](http://last-pm.maunz.de#usage) for guidance for more guidance on usage.
-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