Sections
You are here: Home » Tutorials » Q-edit

Introduction

Q-edit is a new QPRF editor developed under OpenTox which aims at exploiting implemented web services to provide functionality that facilitates the creation of QPRF reports by an end user. In this tutorial we provide instructions on how to use Q-edit: The OpenTox QPRF report editor/viewer.

Overview

  1. Create a QPRF report - How to create your first QPRF report and start using Q-edit
  2. Provide General Information - Specify authors and date of the report
  3. Load a model and carry out a prediction - Specify the OpenTox model used to create the prediction for which the report is prepared
  4. Applicability domain and structural analogues - How reliable is the prediction?
  5. Discuss and save the report - Interpret the findings and save your work

Summary

The QSAR Prediction Reporting Format (QPRF) is a harmonised template for summarizing and reporting substance-specific predictions generated by (Q)SAR models (check the specification here). Q-edit is tool that facilitates the whole procedure of prediction generation and reporting combined with database lookups based on the OpenTox web services.

The OpenTox report on "Automated Validation Report Generation" available here contains the background and progress which has been achieved within OpenTox with respect to the creation of automated reporting facilities for validated (Q)SAR models of predictive toxicology data.

In this tutorial, we will start by reviewing the key requirements of a QPRF report and then proceed with the necessary steps to generate a QPRF report using Q-edit - a new QPRF editor developed under OpenTox to facilitate the creation of QPRF reports by an end user.

Users can download the latest version of the OpenTox QPRF editor (Q-edit) from http://opentox.ntua.gr/files/Q-edit.jar.

[Developers can access the source code at the CVS https://github.com/alphaville/Q-edit. Use the https git directory https://github.com/alphaville/Q-edit.git or the git read-only version: git://github.com/alphaville/Q-edit.git.]

Features

Using Q-edit, users will be able to:

  • Create new QPRF report objects: Q-edit provides detailed guidance throughout the whole procedure of the creation of a QPRF report with user-friendly visualization.
  • Use OpenTox web-services (in the background) to offer to users access to the OpenTox web services. This way, users can
    • Search on-line for compounds
    • Download information for an OpenTox QSAR model
    • Access protected OpenTox resources (securely, over an encrypted SSL connection)
    • Retrieve experimental values for a compound and much more.
    • Run a model to get predictions for a given chemical compound. The whole procedure of generating molecular descriptors and submitting them to the QSAR model runs behind the scenes.
  • Save/Open QPRF report objects using an in-house binary file format (.ro files).
  • Export a report as PDF. The generated PDF is compliant to the EC JRC standards.

Prerequisites

Users have to have installed a "Java Runtime Environment and Virtual Machine" (JVM) on their operating systems. Until now we have tested Q-edit with Sun Java version 1.6.0.22 and 1.6.0.24. Normally, users should not encounter any problems trying to run Q-edit on any other Sun JVMs of newer version or other JVMs.

Optionally, users should install all necessary SSL certificates of various OpenTox sites otherwise they will not be granted access to certain protected resources. Authentication and Authorization in OpenTox requires a secure HTTPS connection. Instructions on how to install the certificates can be found here.

Launching Q-edit

When downloading Q-edit from http://opentox.ntua.gr/files/Q-edit.jar, save the file in any place you like (e.g. on your Desktop). Once the download has completed, launch Q-edit by simply double-clicking the downloaded file "Q-edit.jar". Linux users may need to follow Special Instructions to launch Q-edit.

Additional material

We prompt users to download a sample PDF file from here of a QPRF report for the compound epicorticosterone generated by Q-edit (version 1.0.12). Additionally, a report binary file can be downloaded from here; save the file epicorticosterone.ro in a local directory and use Q-edit to open it: Launch Q-edit, Go to File > Open local resource (Ctrl + O) > Browse to the location of epicorticosterone.ro and click Open.

Evaluation Form

When you're done,  please fill out the Evaluation Form.

--

Next: Create a QPRF report - How to create your first QPRF report and start using Q-edit

Document Actions