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

Code
Comments
Other
Rev Date Author Line
766 16 Sep 08 jari 1 $Id$
766 16 Sep 08 jari 2
766 16 Sep 08 jari 3 = About `se.lu.onk.ReplicateError` =
766 16 Sep 08 jari 4
786 18 Sep 08 jari 5 The `se.lu.onk.ReplicateError` plug-in for BASE is an implementation
786 18 Sep 08 jari 6 of 'Analysis of replicates' in ''Within the fold: assessing
786 18 Sep 08 jari 7 differential expression measures and reproducibility in microarray
786 18 Sep 08 jari 8 assays'', Yang IV et al. Genome Biol. 2002 Oct 24;3(11):research0062
786 18 Sep 08 jari 9 [http://www.ncbi.nlm.nih.gov/entrez/query.fcgi?cmd=Retrieve&db=pubmed&dopt=Abstract&list_uids=12429061 download article].
790 19 Sep 08 jari 10 Two algorithms are implemented, within assays (cf. figure 4 in the
790 19 Sep 08 jari 11 publication) and across assays ((cf. figure 5 in the publication).
766 16 Sep 08 jari 12
766 16 Sep 08 jari 13 `se.lu.onk.ReplicateError` is free software. See the file license.txt for
766 16 Sep 08 jari 14 copying conditions.
766 16 Sep 08 jari 15
766 16 Sep 08 jari 16 The package was created by Johan Enell and is currently maintained by
766 16 Sep 08 jari 17 Jari Häkkinen.
766 16 Sep 08 jari 18
766 16 Sep 08 jari 19
766 16 Sep 08 jari 20 == Downloading ==
766 16 Sep 08 jari 21
766 16 Sep 08 jari 22 `se.lu.onk.ReplicateError` can be obtained from
766 16 Sep 08 jari 23
766 16 Sep 08 jari 24   http://baseplugins.thep.lu.se/wiki/PluginDownload
766 16 Sep 08 jari 25
766 16 Sep 08 jari 26
772 18 Sep 08 jari 27 == Installation and upgrade ==
766 16 Sep 08 jari 28
766 16 Sep 08 jari 29 ''This plug-in is only tested in BASE 2.8 through the
766 16 Sep 08 jari 30 Base1PluginExecuter but is expected to work also in BASE
766 16 Sep 08 jari 31 1.2.17. Please report failure or success in BASE 1.2 through
766 16 Sep 08 jari 32 http://baseplugins.thep.lu.se. These installation instructions only
766 16 Sep 08 jari 33 describe how to get the plug-in to work with the Base1PluginExecuter
766 16 Sep 08 jari 34 in the latest BASE version 2. BASE 1.2 installers should enable one
766 16 Sep 08 jari 35 line in files AAtabs.html and WAtabs.html, read the information in
766 16 Sep 08 jari 36 these short files.''
766 16 Sep 08 jari 37
766 16 Sep 08 jari 38 If you downloaded a binary package you only need to follow these
766 16 Sep 08 jari 39 instructions. If you prefer to compile the package yourself, read the
766 16 Sep 08 jari 40 instructions about compiling and creating a distribution before doing
766 16 Sep 08 jari 41 the installation steps described here.
766 16 Sep 08 jari 42
766 16 Sep 08 jari 43 You need to understand how to install plug-ins in BASE, please refer
766 16 Sep 08 jari 44 to BASE documentation at http://base.thep.lu.se for general
766 16 Sep 08 jari 45 instructions on plug-in installation. The BASE documentation contains
772 18 Sep 08 jari 46 a chapter on plug-ins. If you have read the plug-in information you
772 18 Sep 08 jari 47 should be able to follow this path
766 16 Sep 08 jari 48 {{{
766 16 Sep 08 jari 49   # cd /path/to/base/plugins
766 16 Sep 08 jari 50   # download ReplicateError-version.tgz
766 16 Sep 08 jari 51   # untar ReplicateError-version.tgz
766 16 Sep 08 jari 52   # ln -s ReplicateError-version ReplicateError
766 16 Sep 08 jari 53 }}}
774 18 Sep 08 jari 54 The symbolic link in the last line above allows for easier change to
766 16 Sep 08 jari 55 future version of the plug-in.
766 16 Sep 08 jari 56 {{{
766 16 Sep 08 jari 57   # Log in to your BASE as admin
772 18 Sep 08 jari 58   # Upload the configuration files `pluginConfigurationAA.base` and
772 18 Sep 08 jari 59     `pluginConfigurationWA.base`.
772 18 Sep 08 jari 60   # Create/update one configuration each for across and within assays
772 18 Sep 08 jari 61     mode of the ReplciateError plug-in where you select the plug-in
878 05 Dec 08 jari 62     definition files `pluginConfigurationAA.base` and
772 18 Sep 08 jari 63     `pluginConfigurationWA.base`, respectively. BASE will respond that
772 18 Sep 08 jari 64     plug-ins where configured but ...
766 16 Sep 08 jari 65   # Re-configure the plug-ins without selecting a file, set the
766 16 Sep 08 jari 66     `Plugin executables path` and proceed to next window by clicking
772 18 Sep 08 jari 67     `Next`. This is explained in the BASE documentation and needs to
772 18 Sep 08 jari 68     be done even when you update your plug-in.
766 16 Sep 08 jari 69   # In this parameter window set the `Name of executable`. The value
766 16 Sep 08 jari 70     of this parameter and `Plugin executables path` should add up to
766 16 Sep 08 jari 71     the absolute path to the binaries `runAA` and `runWA`, i.e.,
766 16 Sep 08 jari 72     /path/to/base/plugins/ReplicateError/runAA. How this string looks
766 16 Sep 08 jari 73     like depends on your plug-in directory structure.
766 16 Sep 08 jari 74   # Test the plug-ins and when you are satisfied, share it to your
766 16 Sep 08 jari 75     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
766 16 Sep 08 jari 81 You must checkout the `se.lu.onk.ReplicateError` 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
766 16 Sep 08 jari 88   # cd /path/to/se.lu.onk.ReplicateError
801 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
801 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
786 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
766 16 Sep 08 jari 99 `dist/ReplicateError.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
774 18 Sep 08 jari 104 Update the version number in `build.xml`, and issue `ant
774 18 Sep 08 jari 105 package`. This creates a distribution package with all required
774 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
786 18 Sep 08 jari 111 You can report `se.lu.onk.ReplicateError` 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
766 16 Sep 08 jari 120 The `se.lu.onk.ReplicateError` source repository is available via anonymous
766 16 Sep 08 jari 121 subversion access, issue:
766 16 Sep 08 jari 122
766 16 Sep 08 jari 123   `svn co http://baseplugins.thep.lu.se/svn/plugins/base1/se.lu.onk.ReplicateError/trunk se.lu.onk.ReplicateError`
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
774 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 ----------------------------------------------------------------------
766 16 Sep 08 jari 134 {{{
766 16 Sep 08 jari 135 Copyright (C) 2008 Jari Häkkinen
766 16 Sep 08 jari 136
766 16 Sep 08 jari 137 This file is part of the se.lu.onk.ReplicateError plug-in for
766 16 Sep 08 jari 138 BASE. Available at http://baseplugins.thep.lu.se/ and BASE web site is
766 16 Sep 08 jari 139 http://base.thep.lu.se
766 16 Sep 08 jari 140
766 16 Sep 08 jari 141 This is free software; you can redistribute it and/or modify it under
766 16 Sep 08 jari 142 the terms of the GNU General Public License as published by the Free
766 16 Sep 08 jari 143 Software Foundation; either version 3 of the License, or (at your
766 16 Sep 08 jari 144 option) any later version.
766 16 Sep 08 jari 145
766 16 Sep 08 jari 146 This package is distributed in the hope that it will be useful, but
766 16 Sep 08 jari 147 WITHOUT ANY WARRANTY; without even the implied warranty of
766 16 Sep 08 jari 148 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
766 16 Sep 08 jari 149 General Public License for more details.
766 16 Sep 08 jari 150
766 16 Sep 08 jari 151 You should have received a copy of the GNU General Public License
766 16 Sep 08 jari 152 along with this package. If not, see <http://www.gnu.org/licenses/>.
766 16 Sep 08 jari 153 }}}

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