From ed5760cbaeed7cdb86a37814a37f0d74916ed058 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Thu, 25 Aug 2016 10:52:38 +0200 Subject: adjust documentation --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f31dfec..86e6b5b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # QSAR-Report QMRF and QPRF reporting extension to OpenTox ruby modules and lazar ## About -Class for QMRF and QPRF reporting. +Class for QMRF and QPRF reporting. * QMRF: 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: - Provides a ruby OpenTox class to prepare an initial version of a QPRF report in JSON or HTML. + Provides a ruby OpenTox class to prepare an initial version of a QPRF (version 1.1) report in JSON or HTML. ## Usage ### QMRF @@ -18,7 +18,7 @@ require "qsar-report" report = OpenTox::QMRFReport.new # add a title -report.change_qmrf_tag "QSAR_title", "My QSAR Title" +report.Value "QSAR_title", "My QSAR Title" # add a publication to the publication catalog report.change_catalog :publications_catalog, :publications_catalog_1, {:title => "MyName M (2016) My Publication Title, QSAR News, 10, 14-22", :url => "http://myqsarnewsmag.dom"} @@ -68,6 +68,7 @@ Installation 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) Copyright --------- -- cgit v1.2.3