extensions/net.sf.basedb.mev/trunk/README

Code
Comments
Other
Rev Date Author Line
666 18 Apr 08 nicklas 1 == Requirements ==
666 18 Apr 08 nicklas 2
2211 03 Feb 14 nicklas 3  1. BASE 3.3 or later.
666 18 Apr 08 nicklas 4  
666 18 Apr 08 nicklas 5 == Introduction ==
666 18 Apr 08 nicklas 6
666 18 Apr 08 nicklas 7 This package is an extension package to BASE that installs an action that
666 18 Apr 08 nicklas 8 opens TIGR MultiExperiment Viewer (MEV) as a Java webstart application and
666 18 Apr 08 nicklas 9 automatically imports data from the currently selected bioassay set. This
2211 03 Feb 14 nicklas 10 extension uses the standard MEV 4.9.0 distribution (windows version) that
1703 14 Jun 12 nicklas 11 has been Java Webstart enabled. For more information:
666 18 Apr 08 nicklas 12
666 18 Apr 08 nicklas 13  * The homepage for this extension: 
666 18 Apr 08 nicklas 14    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.mev
666 18 Apr 08 nicklas 15  * The official MEV homepage: http://www.tm4.org/mev.html
666 18 Apr 08 nicklas 16
666 18 Apr 08 nicklas 17 == Installation ==
666 18 Apr 08 nicklas 18
690 12 May 08 nicklas 19  1. Download the mev-launcher-*.tar.gz file.
666 18 Apr 08 nicklas 20  2. Unpack the downloaded file to a directory of your choice.
1383 22 Aug 11 martin 21  3. Copy the mev-launcher.jar file to your BASE plug-ins directory. Look in
1395 15 Sep 11 nicklas 22     your 'base.config' file if you don't know where this is.
1442 02 Nov 11 nicklas 23  4. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
1383 22 Aug 11 martin 24  5. Run the installation wizard and select to install 'mev-launcher.jar'. 
1159 15 Sep 09 nicklas 25  6. Run the 'MeV package installer' plug-in. Find this plug-in on the 
1159 15 Sep 09 nicklas 26     'Administrate -> Plugins -> Definitions' page, click on it, and then
1159 15 Sep 09 nicklas 27     on the 'Run plugin' button. Complete the installation wizard. This will
1159 15 Sep 09 nicklas 28     install required items, eg. data file types, that are required by MeV.
1159 15 Sep 09 nicklas 29  7. The 'MeV CGH exporter' plug-in requires that an admin configures the 
1159 15 Sep 09 nicklas 30     reporter annotations that corresponds to the CGH file columns. Go to the
1082 18 May 09 nicklas 31     'Administrate -> Plugins -> Definitions' page and click on the 
1099 28 May 09 nicklas 32     'MeV CGH exporter' plug-in. Click on 'New configuration...' and 
1082 18 May 09 nicklas 33     enter a name and optionally a description. Then, click on 'Save and
1082 18 May 09 nicklas 34     configure' and select the corresponding reporter annotation columns
1082 18 May 09 nicklas 35     for the four CGH file columns (chromosome, start, end and description).
1159 15 Sep 09 nicklas 36     Finish the configuration.
1395 15 Sep 11 nicklas 37  8. The TDMS and CGH exporter plug-ins are shared to everyone by default. If
1395 15 Sep 11 nicklas 38     that isn't desired, you may want to change this at this stage.
1182 22 Oct 09 nicklas 39  9. Done. 
1068 15 May 09 nicklas 40  
1068 15 May 09 nicklas 41  The MeV Launcher appears as an action in the "Tools" column when
1068 15 May 09 nicklas 42  viewing bioassay sets of an experiment. Some (per-user) options can be 
1068 15 May 09 nicklas 43  specified by opening the 'Extensions -> MeV Launcher options' menu.
666 18 Apr 08 nicklas 44
1068 15 May 09 nicklas 45 The MeV export plug-ins appears in the 'Export' dialog when viewing
1068 15 May 09 nicklas 46 bioassay sets of an experiment.
1068 15 May 09 nicklas 47
666 18 Apr 08 nicklas 48 == Known issues ==
666 18 Apr 08 nicklas 49
2211 03 Feb 14 nicklas 50 MeV modules that use R will not work. 
666 18 Apr 08 nicklas 51
666 18 Apr 08 nicklas 52 == Compiling ==
666 18 Apr 08 nicklas 53
666 18 Apr 08 nicklas 54 To compile this package you also need:
666 18 Apr 08 nicklas 55  
1442 02 Nov 11 nicklas 56  1. Ant 1.8
2211 03 Feb 14 nicklas 57  2. Java 1.7
666 18 Apr 08 nicklas 58
666 18 Apr 08 nicklas 59 Follow these instructions:
666 18 Apr 08 nicklas 60
666 18 Apr 08 nicklas 61  1. Download the source code from the subversion repository. See
666 18 Apr 08 nicklas 62     http://baseplugins.thep.lu.se/wiki/net.sf.basedb.mev for instructions.
666 18 Apr 08 nicklas 63  
1191 22 Feb 10 nicklas 64  2. Type `ant download-lib` to automatically download the BASE core JAR files that
690 12 May 08 nicklas 65     are neeed for compilation. You can also do this manually by copying the 
2211 03 Feb 14 nicklas 66     base-core-3.3.0.jar, base-webclient-3.3.0.jar, base-coreplugins-3.3.0.jar and 
2211 03 Feb 14 nicklas 67     base-webservices-client-3.3.0.jar from the BASE installation directory 
1395 15 Sep 11 nicklas 68     (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
666 18 Apr 08 nicklas 69
666 18 Apr 08 nicklas 70  3. Type 'ant' to compile the code and generate the 'mev-launcher.jar' file
666 18 Apr 08 nicklas 71     in the project directory.
666 18 Apr 08 nicklas 72
666 18 Apr 08 nicklas 73  4. Use 'ant package' to create a downloadable tar.gz package.
690 12 May 08 nicklas 74  
690 12 May 08 nicklas 75 Tip: If you need different values for any of the properties defined in
690 12 May 08 nicklas 76 the 'build.xml' file, create a file named 'build.properties' and set
690 12 May 08 nicklas 77 the values there.
976 26 Feb 09 nicklas 78
976 26 Feb 09 nicklas 79 Note! If upgrading MeV to a new version, the new JAR files needs to 
976 26 Feb 09 nicklas 80 be signed. See `./jarsign/readme.txt` for more information.
976 26 Feb 09 nicklas 81
976 26 Feb 09 nicklas 82
976 26 Feb 09 nicklas 83 == Contributions ==
976 26 Feb 09 nicklas 84
976 26 Feb 09 nicklas 85  * David Waring, for helping out with MeV 4.3 integration.

Generated on Tue Nov 21 03:28:00 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)