| | 1 | = Variant Search extension = |
| | 2 | |
| | 3 | This package is an extension package to BASE that implements |
| | 4 | a variant search engine for the variant calling results created |
| | 5 | be the Reggie variant calling pipeline. The search engine can also |
| | 6 | be used on the Relax server. |
| | 7 | |
| | 8 | |
| | 9 | == Documentation == |
| | 10 | |
| | 11 | * BASE 3.18 and Java 11 or higher is required. |
| | 12 | * [wiki:net.sf.basedb.varsearch/install Installing] TODO! |
| | 13 | * [wiki:net.sf.basedb.varsearch/using How to use] TODO! |
| | 14 | |
| | 15 | |
| | 16 | == License == |
| | 17 | |
| | 18 | [http://www.gnu.org/licenses/agpl-3.0.html GNU Affero General Public License version 3] |
| | 19 | |
| | 20 | |
| | 21 | == Download == |
| | 22 | |
| | 23 | || '''Version''' || '''Revision''' || '''Date''' || '''Binary (tar.gz)''' || '''BASE Version'''* || || |
| | 24 | || 1.0 || - || - || - || 3.18 || [query:"group=resolution&milestone=Variant Search v1.0&order=priority" changelog] || |
| | 25 | |
| | 26 | |
| | 27 | '''*''' In general, each release works with the specified and later BASE versions. |
| | 28 | |
| | 29 | '''Source code''' can be downloaded from the subversion repository. Use the following command to get source code for the 1.0 version (not yet released): |
| | 30 | |
| | 31 | `svn co http://baseplugins.thep.lu.se/svn/extensions/net.sf.basedb.varsearch/tags/1.0 varsearch-1.0` |
| | 32 | |
| | 33 | |
| | 34 | The latest development (''maybe unstable; do not use on a production server'') revision can be checked out from the repository using the following command: |
| | 35 | |
| | 36 | `svn co http://baseplugins.thep.lu.se/svn/extensions/net.sf.basedb.varsearch/trunk varsearch-dev` |
| | 37 | |
| | 38 | |
| | 39 | |
| | 40 | == Contribute == |
| | 41 | |
| | 42 | After making modifications to the source code, compose a clear and concise log message to describe those changes and the reasons for them. Then, send an email to the developers list containing your log message and the output of svn diff (from the top of your subversion working copy). If the community members consider your changes acceptable, someone who has commit privileges will add your changes to the public source code tree. Recall that permission to directly commit changes to the repository is granted on merit - if you demonstrate comprehension of subversion, programming competency, and a ''team spirit'', you will likely be awarded that permission. |
| | 43 | |
| | 44 | |
| | 45 | == Todo == |
| | 46 | [[TicketQuery(status!=closed&component=net.sf.basedb.varsearch)]] |
