summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrautenberg <rautenberg@in-silico.ch>2016-10-06 09:31:42 +0200
committerrautenberg <rautenberg@in-silico.ch>2016-10-06 09:31:42 +0200
commitba44349df57c7b623f15772b07faecf9f9275aaf (patch)
treef9d92293240bf540ed7a910f8785b316c710b9af
parent01b10310d18346a058b29296715b22748363c45b (diff)
readme
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 225822b..c5e2535 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,14 @@
# 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
-Class for QMRF and QPRF reporting.
-* QMRF:
+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/)
-* QPRF:
+* OpenTox::QPRFReport:
Provides a ruby OpenTox class to prepare an initial version of a QPRF (version 1.1) report in JSON or HTML.
## Usage