summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 89de681..f3af312 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
# QSAR-Report
-QMRF and QPRF reporting extension to OpenTox ruby modules and lazar.
+QMRF and QPRF reporting extension to OpenTox ruby modules and lazar.
+The QSAR-report gem was developed to extend the lazar and nano-lazar toxicity prediction application with QMRF and QPRF reporting features.
+The library gem is independent from lazar or nano-lazar and can also be used in any other ruby code.
+
## About
Classes for QMRF and QPRF reporting.
+
* OpenTox::QMRFReport:
Provides a ruby OpenTox class to prepare an initial version of a QMRF report.
The XML output is in QMRF version 1.3 and can be finalized with the QMRF editor 2.0 (https://sourceforge.net/projects/qmrf/)
@@ -9,6 +13,7 @@ Classes for QMRF and QPRF reporting.
Provides a ruby OpenTox class to prepare an initial version of a QPRF (version 1.1) report in JSON or HTML.
## Usage
+
### QMRF
create a new QMRF report, add some content and show output:
```ruby