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

Code
Comments
Other
Rev Date Author Line
1090 27 May 09 nicklas 1 == Requirements ==
1090 27 May 09 nicklas 2
1117 10 Jun 09 nicklas 3  1. BASE 2.13 or later.
1138 24 Jun 09 nicklas 4  2. Ant 1.7 or later (for installation only).
1138 24 Jun 09 nicklas 5  3. Access to a GenePattern server (3.2 or higher recommended).
1090 27 May 09 nicklas 6  
1090 27 May 09 nicklas 7 == Introduction ==
1090 27 May 09 nicklas 8
1138 24 Jun 09 nicklas 9 This package is an extensions/plug-in package to BASE that integrates BASE
1138 24 Jun 09 nicklas 10 with GenePattern. Some of the features:
1090 27 May 09 nicklas 11
1138 24 Jun 09 nicklas 12  * Export experimental data in various GenePattern file formats.
1138 24 Jun 09 nicklas 13  * Run jobs on a GenePattern server using files from BASE. Module
1138 24 Jun 09 nicklas 14    parameters are entered in the BASE web interface.
1138 24 Jun 09 nicklas 15  * Start GenePattern visualizer modules with files from BASE.
1138 24 Jun 09 nicklas 16
1138 24 Jun 09 nicklas 17 This extension doesn't include any GenePattern software. It uses
1138 24 Jun 09 nicklas 18 web services to communicate with GenePattern servers. BASE users
1138 24 Jun 09 nicklas 19 that want to use GenePattern must have an account on a separate 
1138 24 Jun 09 nicklas 20 GenePattern server.
1138 24 Jun 09 nicklas 21
1090 27 May 09 nicklas 22 For more information:
1090 27 May 09 nicklas 23
1090 27 May 09 nicklas 24  * The homepage for this extension: 
1090 27 May 09 nicklas 25    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.genepattern
1138 24 Jun 09 nicklas 26  * The GenePattern homepage: 
1138 24 Jun 09 nicklas 27    http://www.broad.mit.edu/cancer/software/genepattern/index.html
1090 27 May 09 nicklas 28
1090 27 May 09 nicklas 29 == Installation ==
1090 27 May 09 nicklas 30
1090 27 May 09 nicklas 31  1. Download the gp-integration-*.tar.gz file.
1090 27 May 09 nicklas 32  2. Unpack the downloaded file to a directory of your choice.
1138 24 Jun 09 nicklas 33  3. Download GenePattern files from a GenePattern server.
1138 24 Jun 09 nicklas 34     Type `ant -f download.xml`. This will dowload the files from the public
1138 24 Jun 09 nicklas 35     GenePattern server at http://genepattern.broad.mit.edu/gp. You may
1138 24 Jun 09 nicklas 36     download from an alternate location by setting the `genepattern.url`
1138 24 Jun 09 nicklas 37     property: `ant -f download.xml -Dgenepattern.url=http://your.genepattern.server/gp`
1138 24 Jun 09 nicklas 38     This will download the following files.
1138 24 Jun 09 nicklas 39      * runVisualizer.jar: This file is added to gp-integration.jar/resources/visualizer
1138 24 Jun 09 nicklas 40      * GenePattern.zip: The `GenePattern.jar` and `lib/gp-modules.jar` are extracted
1138 24 Jun 09 nicklas 41        to the `lib/genepattern` directory.
1138 24 Jun 09 nicklas 42  4. Copy the `gp-integration.jar` file and the `lib` directory, including sub-
1104 29 May 09 nicklas 43     directories and files, to your BASE extensions directory, `WEB-INF/extensions`.
1138 24 Jun 09 nicklas 44  5. Run the 'Extensions -> Manual scan' command if you have disabled automatic
1090 27 May 09 nicklas 45     installation. Otherwise, just wait a bit and the automatic installation will
1090 27 May 09 nicklas 46     find and install the new extension.
1138 24 Jun 09 nicklas 47  6. Run the plug-in installation wizard by clicking the 'New' button on the
1090 27 May 09 nicklas 48     'Administrate -> Plugins -> Definitions' page. Make sure the option for
1090 27 May 09 nicklas 49     the 'Extensions directory' is selected. Install all plug-ins found in 
1090 27 May 09 nicklas 50     the gp-integration.jar file.
1090 27 May 09 nicklas 51  7. Done. 
1090 27 May 09 nicklas 52
1138 24 Jun 09 nicklas 53 == Using ==
1104 29 May 09 nicklas 54
1138 24 Jun 09 nicklas 55 '''Register GenePattern account with BASE'''[[br]]
1138 24 Jun 09 nicklas 56 BASE users that want's to use this extensions must have access to at
1138 24 Jun 09 nicklas 57 least one GenePattern server. The first step is to register the account
1138 24 Jun 09 nicklas 58 information with BASE. Go to `Extensions -> GenePattern options`. Add
1138 24 Jun 09 nicklas 59 information for one or more GenePattern servers. For each server the
1138 24 Jun 09 nicklas 60 following information should be provided:
1138 24 Jun 09 nicklas 61
1138 24 Jun 09 nicklas 62  * Server url: Only include the root url (not the /gp)
1138 24 Jun 09 nicklas 63  * Login: Your login information (email)
1138 24 Jun 09 nicklas 64  * Password: If the server requires a password
1138 24 Jun 09 nicklas 65  * BASE server URL: The URL to BASE as seen from the GenePattern server.
1138 24 Jun 09 nicklas 66    The default value is usually correct, but may need to be changed due
1138 24 Jun 09 nicklas 67    to, for example, proxies.
1138 24 Jun 09 nicklas 68
1138 24 Jun 09 nicklas 69 Use the `Test` button to verify the login information. If there is problem with
1138 24 Jun 09 nicklas 70 transfering files to the GenePattern server an incorrect value for the BASE server 
1138 24 Jun 09 nicklas 71 URL is most likely the cause.
1138 24 Jun 09 nicklas 72
1138 24 Jun 09 nicklas 73 '''Configuring the GenePattern analysis plug-in'''[[br]]
1138 24 Jun 09 nicklas 74 Before it is possible to run jobs on a GenePattern server the `GenePattern analysis`
1138 24 Jun 09 nicklas 75 plug-in must be configured. Each GenePattern module requires a separate configuration.
1138 24 Jun 09 nicklas 76 Go to the `Administrate -> Plugins -> Definitions` page and find the 
1138 24 Jun 09 nicklas 77 `GenePattern analysis` plug-in. Create a new configuration and start the 
1138 24 Jun 09 nicklas 78 configuration sequence.
1138 24 Jun 09 nicklas 79
1138 24 Jun 09 nicklas 80  1. In the first step you select a GenePattern server and a module. Use the
1138 24 Jun 09 nicklas 81     `Get list` button to retrieve a list of installed modules on the selected
1138 24 Jun 09 nicklas 82     GenePattern server. Note! The selected GenePattern server is used only 
1138 24 Jun 09 nicklas 83     during configuration. Users may select a different server (as long as
1138 24 Jun 09 nicklas 84     the module is installed there) for executing jobs.
1138 24 Jun 09 nicklas 85  2. In the second step you can set default values for all non-file parameters
1138 24 Jun 09 nicklas 86     and link file parameters with BASE file types. The linking to file types 
1138 24 Jun 09 nicklas 87     makes it possible for BASE to suggest a default file that is already
1138 24 Jun 09 nicklas 88     associated with the bioassay set.
1138 24 Jun 09 nicklas 89
1138 24 Jun 09 nicklas 90 '''Using the GenePattern analysis plug-in'''[[br]]
1138 24 Jun 09 nicklas 91 To run a job on a GenePattern server the `GenePattern analysis` plug-in is
1138 24 Jun 09 nicklas 92 used from the bioassay set view. 
1138 24 Jun 09 nicklas 93
1138 24 Jun 09 nicklas 94  1. In the first step some information about the new child bioassay set can
1138 24 Jun 09 nicklas 95     be entered. The user must also select a GenePattern server and specify
1138 24 Jun 09 nicklas 96     a directory in the BASE file system were the result files should be
1138 24 Jun 09 nicklas 97     saved.
1138 24 Jun 09 nicklas 98  2. In the second step input files and other parameter values are entered.
1138 24 Jun 09 nicklas 99
1138 24 Jun 09 nicklas 100 To run a visualizer module, use the `GenePattern visualizer` button
1138 24 Jun 09 nicklas 101 from the bioassay set view.
1138 24 Jun 09 nicklas 102
1138 24 Jun 09 nicklas 103  1. In the first step you select a GenePattern server and a module. Use the 
1138 24 Jun 09 nicklas 104     `Get list` button to retreive a list of installed modules on the selected
1138 24 Jun 09 nicklas 105     GenePattern server.
1138 24 Jun 09 nicklas 106  2. In the second step input files and other parameter values are entered.
1138 24 Jun 09 nicklas 107  3. After this, the visualizer applet is started. This applet is just a wrapper
1138 24 Jun 09 nicklas 108     that downloads the required module and the data files to the local computer 
1138 24 Jun 09 nicklas 109     and starts a Java program. Please be patient as this may take some while.
1138 24 Jun 09 nicklas 110
1090 27 May 09 nicklas 111 == Known issues ==
1090 27 May 09 nicklas 112
1090 27 May 09 nicklas 113 None.
1090 27 May 09 nicklas 114
1090 27 May 09 nicklas 115 == Compiling ==
1090 27 May 09 nicklas 116
1090 27 May 09 nicklas 117 To compile this package you also need:
1090 27 May 09 nicklas 118  
1138 24 Jun 09 nicklas 119  1. Ant 1.7
1090 27 May 09 nicklas 120  2. Java 1.6
1090 27 May 09 nicklas 121
1090 27 May 09 nicklas 122 Follow these instructions:
1090 27 May 09 nicklas 123
1090 27 May 09 nicklas 124  1. Download the source code from the subversion repository. See
1090 27 May 09 nicklas 125     http://baseplugins.thep.lu.se/wiki/net.sf.basedb.genepattern
1090 27 May 09 nicklas 126     for instructions.
1090 27 May 09 nicklas 127  
1138 24 Jun 09 nicklas 128  2. Type `ant download-lib` to automatically download the BASE and GenePattern 
1138 24 Jun 09 nicklas 129     files that are needed for compilation. 
1090 27 May 09 nicklas 130
1090 27 May 09 nicklas 131  3. Type 'ant' to compile the code and generate the 'gp-integration.jar' file
1090 27 May 09 nicklas 132     in the project directory.
1090 27 May 09 nicklas 133
1138 24 Jun 09 nicklas 134  4. Use 'ant package' to create a downloadable tar.gz package. Note that this
1138 24 Jun 09 nicklas 135     package doesn't include any of the GenePattern files.
1090 27 May 09 nicklas 136  
1090 27 May 09 nicklas 137 Tip: If you need different values for any of the properties defined in
1090 27 May 09 nicklas 138 the 'build.xml' file, create a file named 'build.properties' and set
1090 27 May 09 nicklas 139 the values there.

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