README.md in qsar-report-1.0.0 vs README.md in qsar-report-1.0.1

- old
+ new

@@ -1,16 +1,21 @@ # 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 + ### QMRF create a new QMRF report, add some content and show output: ```ruby require "qsar-report" @@ -64,10 +69,10 @@ ``` Installation ------------ - gem install qsar-report + gem install qsar-report Documentation ------------- * [RubyDoc.info Code documentation](http://www.rubydoc.info/gems/qsar-report) * For full information on QSAR reporting see: [JRC QSAR Model Database and QSAR Model Reporting Formats](https://eurl-ecvam.jrc.ec.europa.eu/databases/jrc-qsar-model-database-and-qsar-model-reporting-formats)