source: plugins/base2/net.sf.basedb.examples/trunk/README @ 647

Last change on this file since 647 was 647, checked in by Nicklas Nordborg, 13 years ago

References #105: Complete the move of the example code from BASE.

First checkin of plug-in examples.

  • Property svn:mime-type set to text/x-trac-wiki
File size: 1.6 KB

Requirements

  1. BASE 2.6.0 or later.

Introduction

This package contains some simple BASE plug-in examples. The target group is developers that want's to create their own BASE plug-ins. To install the plug-ins you need a local installation of BASE or administrator access to an existing BASE installation. We don't recommend that the example plug-ins are installed on a production server.

Read http://base.thep.lu.se/chrome/site/latest/html/developerdoc/plugin_developer/plugin_developer.html for more information about developing BASE plug-ins.

Currently, this package contains the following plug-ins:

  • An importer that pretends to be able to import samples. It will accept any file, but doesn't do anything. Main purpose is to show parameter handling with plug-ins.
  • An analyser plug-in that does some bogus calculations on a bioassay set. Main purpose is to show how a plug-in can access analysed data, do some calculations and store the result as a new bioassay set.

Installation

  1. Unpack the tar.gz file to a directory of your choice.
  2. Copy the example-plugins.jar to your BASE plug-in directory.
  3. Install the plug-ins using the BASE web interface. See http://base.thep.lu.se/chrome/site/latest/html/admindoc/plugin_installation/plugins.installation.html for more information.
  4. Done.

Compiling

To compile this package you also need:

  1. Ant 1.6
  2. Java 1.6

Follow these instructions:

  1. Type 'ant' to compile the code and generate the 'example-plugins.jar' file in the project directory.
  1. Use 'ant package' to create a downloadable tar.gz package in the project directory.
Note: See TracBrowser for help on using the repository browser.