summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristoph Helma <helma@in-silico.ch>2012-03-09 22:04:06 +0000
committerChristoph Helma <helma@in-silico.ch>2012-03-09 22:04:06 +0000
commite11e5c3a521561cc42b80c667c12e71438ea12e1 (patch)
tree88c90e89e6316698b211b7a280a388a8520f2c1b
parentedfdc45754c05507deb63b16cb09dbdca6c8400f (diff)
gemspec updated
-rw-r--r--README.markdown32
-rw-r--r--opentox-client.gemspec1
2 files changed, 4 insertions, 29 deletions
diff --git a/README.markdown b/README.markdown
index 5f12ad9..f4e20f4 100644
--- a/README.markdown
+++ b/README.markdown
@@ -6,38 +6,12 @@ Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API
Installation
------------
- sudo gem install opentox-ruby-minimal
+ gem install opentox-client
-opentox-ruby depends on [rapper](http://librdf.org/raptor/rapper.html) for parsing OWL-DL in RDFXML format.
-
-Quickstart
-----------
-
-This example shows how to create a lazar model and predict a compound, it assumes that you have access to a working installation of OpenTox services with corresponding settings in $HOME/.opentox/config. Run the following code in irb or from a ruby script:
-
- require 'rubygems'
- require 'opentox-ruby'
-
- # Authenticate
- subjectid = OpenTox::Authorization.authenticate(USER,PASSWORD)
-
- # Upload a dataset
- training_dataset = OpenTox::Dataset.create_from_csv_file(TRAINING_DATASET, subjectid)
-
- # Create a prediction model
- model_uri = OpenTox::Algorithm::Lazar.new.run({:dataset_uri => training_dataset.uri, :subjectid => subjectid}).to_s
- lazar = OpenTox::Model::Lazar.find model_uri, subjectid
-
- # Predict a compound
- compound = OpenTox::Compound.from_smiles("c1ccccc1NN")
- prediction_uri = lazar.run(:compound_uri => compound.uri, :subjectid => subjectid)
- prediction = OpenTox::LazarPrediction.find(prediction_uri, subjectid)
- puts prediction.to_yaml
-
-[API documentation](http://rdoc.info/gems/opentox-ruby-minimal)
+[API documentation](http://rdoc.info/gems/opentox-client)
-------------------------------------------------------------------
Copyright
---------
-Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details.
+Copyright (c) 2009-2012 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details.
diff --git a/opentox-client.gemspec b/opentox-client.gemspec
index f8fb9a4..198a6ed 100644
--- a/opentox-client.gemspec
+++ b/opentox-client.gemspec
@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
s.homepage = "http://github.com/opentox/opentox-client"
s.summary = %q{Ruby wrapper for the OpenTox REST API}
s.description = %q{Ruby wrapper for the OpenTox REST API (http://www.opentox.org)}
+ s.license = 'GPL-3'
s.rubyforge_project = "opentox-client"