plugins/base1/se.lu.onk.VirtualArray/trunk/README

Code
Comments
Other
Rev Date Author Line
766 16 Sep 08 jari 1 $Id$
766 16 Sep 08 jari 2
895 08 Dec 08 jari 3 = About `se.lu.onk.VirtualArray` =
766 16 Sep 08 jari 4
996 26 Mar 09 jari 5 The `se.lu.onk.VirtualArray` plug-in is a program that creates a
996 26 Mar 09 jari 6 virtual array design for bioassays. A consequence is that the position
996 26 Mar 09 jari 7 number of each spot is changed to a negative value. The new positions
996 26 Mar 09 jari 8 are a descending integer sequence starting from -1.
766 16 Sep 08 jari 9
2126 08 Nov 13 jari 10 `se.lu.onk.VirtualArray` is open source software. See the file
2126 08 Nov 13 jari 11 license.txt for copying conditions.
766 16 Sep 08 jari 12
2126 08 Nov 13 jari 13 The package was created by Johan Enell.
766 16 Sep 08 jari 14
766 16 Sep 08 jari 15
766 16 Sep 08 jari 16 == Downloading ==
766 16 Sep 08 jari 17
895 08 Dec 08 jari 18 `se.lu.onk.VirtualArray` can be obtained from
766 16 Sep 08 jari 19
766 16 Sep 08 jari 20   http://baseplugins.thep.lu.se/wiki/PluginDownload
766 16 Sep 08 jari 21
766 16 Sep 08 jari 22
772 18 Sep 08 jari 23 == Installation and upgrade ==
766 16 Sep 08 jari 24
2126 08 Nov 13 jari 25 ''This plug-in is only tested in BASE through the
2126 08 Nov 13 jari 26 Base1PluginExecuter and may work also in BASE
766 16 Sep 08 jari 27 1.2.17. Please report failure or success in BASE 1.2 through
766 16 Sep 08 jari 28 http://baseplugins.thep.lu.se. These installation instructions only
766 16 Sep 08 jari 29 describe how to get the plug-in to work with the Base1PluginExecuter
2126 08 Nov 13 jari 30 in the latest BASE version 3.2.x version.''
766 16 Sep 08 jari 31
766 16 Sep 08 jari 32 If you downloaded a binary package you only need to follow these
766 16 Sep 08 jari 33 instructions. If you prefer to compile the package yourself, read the
766 16 Sep 08 jari 34 instructions about compiling and creating a distribution before doing
766 16 Sep 08 jari 35 the installation steps described here.
766 16 Sep 08 jari 36
766 16 Sep 08 jari 37 You need to understand how to install plug-ins in BASE, please refer
766 16 Sep 08 jari 38 to BASE documentation at http://base.thep.lu.se for general
766 16 Sep 08 jari 39 instructions on plug-in installation. The BASE documentation contains
772 18 Sep 08 jari 40 a chapter on plug-ins. If you have read the plug-in information you
772 18 Sep 08 jari 41 should be able to follow this path
766 16 Sep 08 jari 42 {{{
766 16 Sep 08 jari 43   # cd /path/to/base/plugins
895 08 Dec 08 jari 44   # download VirtualArray-version.tgz
895 08 Dec 08 jari 45   # untar VirtualArray-version.tgz
895 08 Dec 08 jari 46   # ln -s VirtualArray-version VirtualArray
766 16 Sep 08 jari 47 }}}
776 18 Sep 08 jari 48 The symbolic link in the last line above allows for easier change to
766 16 Sep 08 jari 49 future version of the plug-in.
766 16 Sep 08 jari 50 {{{
766 16 Sep 08 jari 51   # Log in to your BASE as admin
895 08 Dec 08 jari 52   # Upload the configuration file lib/pluginVirtualArray.base`
776 18 Sep 08 jari 53   # Create/update a configuration for the plug-in where you select the
895 08 Dec 08 jari 54     plug-in definition file `pluginVirtualArray.base`. BASE
879 05 Dec 08 jari 55     will respond that plug-ins where configured but ...
776 18 Sep 08 jari 56   # Re-configure the plug-in without selecting a file, set the `Plugin
776 18 Sep 08 jari 57     executables path` and proceed to next window by clicking
772 18 Sep 08 jari 58     `Next`. This is explained in the BASE documentation and needs to
772 18 Sep 08 jari 59     be done even when you update your plug-in.
766 16 Sep 08 jari 60   # In this parameter window set the `Name of executable`. The value
766 16 Sep 08 jari 61     of this parameter and `Plugin executables path` should add up to
776 18 Sep 08 jari 62     the absolute path to the binary `run`, i.e.,
895 08 Dec 08 jari 63     /path/to/base/plugins/VirtualArray/run. How this string looks
766 16 Sep 08 jari 64     like depends on your plug-in directory structure.
2126 08 Nov 13 jari 65   # Create a formula (not needed when you upgrade):
2126 08 Nov 13 jari 66     - Go to View -> Formulas page and click on the New button.
2126 08 Nov 13 jari 67     - In the popup window enter the following information:
2126 08 Nov 13 jari 68         Name: reporter
2126 08 Nov 13 jari 69         Expressions: rep('id')
2126 08 Nov 13 jari 70         Value type: Integer
2126 08 Nov 13 jari 71         Avg. method: None
2126 08 Nov 13 jari 72         // All other parameters can be left at their default values.
2126 08 Nov 13 jari 73      - Save.
2126 08 Nov 13 jari 74   # Test the plug-in and when you are satisfied, share the plug-in and
2126 08 Nov 13 jari 75     formula to your users.
766 16 Sep 08 jari 76 }}}
766 16 Sep 08 jari 77
766 16 Sep 08 jari 78
766 16 Sep 08 jari 79 == Compiling ==
766 16 Sep 08 jari 80
895 08 Dec 08 jari 81 You must checkout the `se.lu.onk.VirtualArray` from the repository,
766 16 Sep 08 jari 82 follow the instructions below. Then download and untar the
766 16 Sep 08 jari 83 `se.lu.onk.BaseFile` package available from
766 16 Sep 08 jari 84 http://baseplugins.thep.lu.se/wiki/PluginDownload. This package is
766 16 Sep 08 jari 85 known to work with `se.lu.onk.BaseFile` version 1.0.
766 16 Sep 08 jari 86 {{{
766 16 Sep 08 jari 87   check out project, see instructions below
895 08 Dec 08 jari 88   # cd /path/to/se.lu.onk.VirtualArray
804 01 Oct 08 jari 89   # wget http://baseplugins.thep.lu.se/attachment/wiki/se.lu.onk.BaseFile/BaseFile-1.0.tgz?format=raw -O BaseFile-1.0.tgz
804 01 Oct 08 jari 90   # wget http://baseplugins.thep.lu.se/attachment/wiki/se.lu.onk.BaseFile/BaseFile-1.0.tgz.MD5?format=raw -O BaseFile-1.0.tgz.MD5
788 18 Sep 08 jari 91   # optionally compare the MD5 sum of the downloaded file and the MD5-file
766 16 Sep 08 jari 92   # tar zxpf BaseFile-1.0.tgz
766 16 Sep 08 jari 93   # ln -s BaseFile-1.0 BaseFile
766 16 Sep 08 jari 94     or
766 16 Sep 08 jari 95   # mv BaseFile-1.0 BaseFile
766 16 Sep 08 jari 96 }}}
766 16 Sep 08 jari 97 It is important that the `BaseFile` package is located in directory
766 16 Sep 08 jari 98 `BaseFile`. Now simple issue `ant`. This will create a jar file
895 08 Dec 08 jari 99 `dist/VirtualArray.jar`.
766 16 Sep 08 jari 100
766 16 Sep 08 jari 101
766 16 Sep 08 jari 102 == Creating a distribution ==
766 16 Sep 08 jari 103
776 18 Sep 08 jari 104 Update the version number in `build.xml`, and issue `ant
776 18 Sep 08 jari 105 package`. This creates a distribution package with all required
776 18 Sep 08 jari 106 components, including BaseFile.jar and associated files.
766 16 Sep 08 jari 107
766 16 Sep 08 jari 108
766 16 Sep 08 jari 109 == Bug Reporting ==
766 16 Sep 08 jari 110
895 08 Dec 08 jari 111 You can report `se.lu.onk.VirtualArray` bugs on
766 16 Sep 08 jari 112
766 16 Sep 08 jari 113   http://baseplugins.thep.lu.se/newticket
766 16 Sep 08 jari 114
766 16 Sep 08 jari 115 Use user `base` and password `base`.
766 16 Sep 08 jari 116
766 16 Sep 08 jari 117
766 16 Sep 08 jari 118 == Subversion Access ==
766 16 Sep 08 jari 119
895 08 Dec 08 jari 120 The `se.lu.onk.VirtualArray` source repository is available via anonymous
766 16 Sep 08 jari 121 subversion access, issue:
766 16 Sep 08 jari 122
895 08 Dec 08 jari 123   `svn co http://baseplugins.thep.lu.se/svn/plugins/base1/se.lu.onk.VirtualArray/trunk se.lu.onk.VirtualArray`
766 16 Sep 08 jari 124
766 16 Sep 08 jari 125 There is no guarantees about the contents or quality of the latest
766 16 Sep 08 jari 126 code in the subversion repository: it is not unheard of for code that
766 16 Sep 08 jari 127 is known to be broken to be committed to the repository. Use at your
766 16 Sep 08 jari 128 own risk. You may prefer to check out a released version instead, then
776 18 Sep 08 jari 129 replace `trunk` with `tags/version` in the above example.
766 16 Sep 08 jari 130
766 16 Sep 08 jari 131
766 16 Sep 08 jari 132 ----------------------------------------------------------------------
766 16 Sep 08 jari 133 {{{
2126 08 Nov 13 jari 134 Copyright (C) 2008, 2009, 2013 Jari Häkkinen
766 16 Sep 08 jari 135
895 08 Dec 08 jari 136 This file is part of the se.lu.onk.VirtualArray plug-in for
895 08 Dec 08 jari 137 BASE. Available at http://baseplugins.thep.lu.se/ and BASE web site is
766 16 Sep 08 jari 138 http://base.thep.lu.se
766 16 Sep 08 jari 139
766 16 Sep 08 jari 140 This is free software; you can redistribute it and/or modify it under
766 16 Sep 08 jari 141 the terms of the GNU General Public License as published by the Free
766 16 Sep 08 jari 142 Software Foundation; either version 3 of the License, or (at your
766 16 Sep 08 jari 143 option) any later version.
766 16 Sep 08 jari 144
766 16 Sep 08 jari 145 This package is distributed in the hope that it will be useful, but
766 16 Sep 08 jari 146 WITHOUT ANY WARRANTY; without even the implied warranty of
766 16 Sep 08 jari 147 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
766 16 Sep 08 jari 148 General Public License for more details.
766 16 Sep 08 jari 149
766 16 Sep 08 jari 150 You should have received a copy of the GNU General Public License
766 16 Sep 08 jari 151 along with this package. If not, see <http://www.gnu.org/licenses/>.
766 16 Sep 08 jari 152 }}}

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