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

Code
Comments
Other
Rev Date Author Line
6107 22 Jan 21 nicklas 1 == Requirements ==
6107 22 Jan 21 nicklas 2
7059 13 Mar 23 nicklas 3  1. BASE 3.19.8 or later.
6107 22 Jan 21 nicklas 4  2. Java 11 or later.
6107 22 Jan 21 nicklas 5  
6107 22 Jan 21 nicklas 6 == Introduction ==
6107 22 Jan 21 nicklas 7
6107 22 Jan 21 nicklas 8 This package is an extension package to BASE that adds support
6107 22 Jan 21 nicklas 9 for searching for variants found by the Reggie variant calling
6107 22 Jan 21 nicklas 10 pipeline. This extension works both in the Reggie production 
6107 22 Jan 21 nicklas 11 environment and in the Relax data release environment.
6107 22 Jan 21 nicklas 12
6107 22 Jan 21 nicklas 13
6107 22 Jan 21 nicklas 14  * The homepage for this extension: 
6312 11 Jun 21 nicklas 15    https://baseplugins.thep.lu.se/wiki/net.sf.basedb.varsearch
6107 22 Jan 21 nicklas 16    
6107 22 Jan 21 nicklas 17 == Installation ==
6107 22 Jan 21 nicklas 18
6312 11 Jun 21 nicklas 19 See https://baseplugins.thep.lu.se/wiki/net.sf.basedb.varsearch/install
6107 22 Jan 21 nicklas 20  
6107 22 Jan 21 nicklas 21 == Using ==
6107 22 Jan 21 nicklas 22
6312 11 Jun 21 nicklas 23 See https://baseplugins.thep.lu.se/wiki/net.sf.basedb.varsearch/using
6107 22 Jan 21 nicklas 24
6107 22 Jan 21 nicklas 25
6107 22 Jan 21 nicklas 26 == Compiling ==
6107 22 Jan 21 nicklas 27
6107 22 Jan 21 nicklas 28 To compile this package you also need:
6107 22 Jan 21 nicklas 29  
6107 22 Jan 21 nicklas 30  1. Ant 1.10
6107 22 Jan 21 nicklas 31  2. Java 11
6107 22 Jan 21 nicklas 32
6107 22 Jan 21 nicklas 33 Follow these instructions:
6107 22 Jan 21 nicklas 34
6107 22 Jan 21 nicklas 35  1. Download the source code from the subversion repository. See
6312 11 Jun 21 nicklas 36     https://baseplugins.thep.lu.se/wiki/net.sf.basedb.varsearch for instructions.
6107 22 Jan 21 nicklas 37  
6107 22 Jan 21 nicklas 38  2. Type `ant download-lib` to automatically download the BASE core JAR files that
6107 22 Jan 21 nicklas 39     are neeed for compilation. You can also do this manually by copying the 
6107 22 Jan 21 nicklas 40     base-core-3.x.jar file from the BASE installation directory 
6107 22 Jan 21 nicklas 41     (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
6107 22 Jan 21 nicklas 42
6107 22 Jan 21 nicklas 43  3. Type 'ant' to compile the code and generate the 'varsearch.jar' file
6107 22 Jan 21 nicklas 44     in the project directory.
6107 22 Jan 21 nicklas 45
6107 22 Jan 21 nicklas 46  4. Use 'ant package' to create a downloadable tar.gz package.
6107 22 Jan 21 nicklas 47  
6107 22 Jan 21 nicklas 48 Tip: If you need different values for any of the properties defined in
6107 22 Jan 21 nicklas 49 the 'build.xml' file, create a file named 'build.properties' and set
6107 22 Jan 21 nicklas 50 the values there.
6107 22 Jan 21 nicklas 51